diff --git a/.DS_Store b/.DS_Store
deleted file mode 100644
index 1826c33..0000000
Binary files a/.DS_Store and /dev/null differ
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..ebda541
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,37 @@
+
+
+## Description
+
+Describe the technical changes you did.
+
+## Why is it needed?
+
+Describe the issue you are solving.
+
+## Screenshot or GIFs (if applicable)
+
+If the changes include visual modifications, include screenshots or GIFs to demonstrate the before and after effects.
+
+## Testing
+
+Describe the testing strategy employed for this PR, including any manual or automated tests conducted. Specify the testing environment and provide clear instructions for reviewers on how to reproduce the tests, if applicable.
+
+## Related issue(s)/PR(s)
+
+Let us know if this is related to any issue/pull request
+
+## Additional Notes
+
+Include any additional information or context that may be helpful for reviewers.
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..6a9620c
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,25 @@
+# dependencies
+node_modules
+/.pnp
+.pnp.js
+.yarn/install-state.gz
+
+# testing
+/coverage
+
+# production
+build
+dist
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+.env
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..212abf5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,111 @@
+
+
+
+
+
PROFANITY.DEV
+
+
+ A fast, free and open-source profanity filter for your web apps
+
+
+## Overview
+
+
+ Table of Contents
+
+- [ Overview](#-overview)
+- [ Getting Started](#-getting-started)
+ - [ Installation](#-installation)
+ - [ Usage](#-usage)
+ - [ Tests](#-tests)
+- [ Project Roadmap](#-project-roadmap)
+- [ Contributing](#-contributing)
+- [ License](#-license)
+- [ Acknowledgments](#-acknowledgments)
+
+
+### Project structure
+
+```sh
+└── profanity.dev/
+ ├── tensor-api # Hono serverless api
+ ├── vector-api # Hono serverless api
+ └── www # NextJs application
+```
+
+## Getting Started
+
+**System Requirements:**
+
+:construction:
+
+### Installation
+
+:construction:
+
+### Usage
+
+:construction:
+
+### Tests
+
+:construction:
+
+## Project Roadmap
+
+- [x] `â–º INSERT-TASK-1`
+- [ ] `â–º INSERT-TASK-2`
+- [ ] `â–º ...`
+
+## Contributing
+
+Contributions are welcome! Here are several ways you can contribute:
+
+- **[Report Issues](https://github.com/joschan21/profanity.dev/issues)**: Submit bugs found or log feature requests for the `profanity.dev` project.
+- **[Submit Pull Requests](https://github.com/joschan21/profanity.dev/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs.
+- **[Join the Discussions](https://github.com/joschan21/profanity.dev/discussions)**: Share your insights, provide feedback, or ask questions.
+
+
+Contributing Guidelines
+
+1. **Fork the Repository**: Start by forking the project repository to your github account.
+2. **Clone Locally**: Clone the forked repository to your local machine using a git client.
+ ```sh
+ git clone https://github.com//profanity.dev
+ ```
+3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name.
+ ```sh
+ git checkout -b new-feature-x
+ ```
+4. **Make Your Changes**: Develop and test your changes locally.
+5. **Commit Your Changes**: Commit with a clear message describing your updates.
+ ```sh
+ git commit -m 'feat: implemented new feature x.'
+ ```
+6. **Push to github**: Push the changes to your forked repository.
+ ```sh
+ git push -u origin new-feature-x
+ ```
+7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations.
+8. **Review**: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
+
+
+
+Contributor Graph
+
+
+
+
+
+
+
+
+## License
+
+This project is protected under the [SELECT-A-LICENSE](https://choosealicense.com/licenses) License. For more details, refer to the [LICENSE](https://choosealicense.com/licenses/) file.
+
+## Acknowledgments
+
+- List any resources, contributors, inspiration, etc. here.
+
+[**Return**](#-overview)
diff --git a/tensor-api/.DS_Store b/tensor-api/.DS_Store
deleted file mode 100644
index acc3f86..0000000
Binary files a/tensor-api/.DS_Store and /dev/null differ
diff --git a/tensor-api/.gitignore b/tensor-api/.gitignore
index 6fc3aaa..8b75ff2 100644
--- a/tensor-api/.gitignore
+++ b/tensor-api/.gitignore
@@ -1,4 +1,5 @@
.env
node_modules
.wrangler
-wrangler.toml
\ No newline at end of file
+wrangler.toml
+.DS_Store
\ No newline at end of file
diff --git a/vector-api/.gitignore b/vector-api/.gitignore
index 462edf6..5bb0b05 100644
--- a/vector-api/.gitignore
+++ b/vector-api/.gitignore
@@ -2,4 +2,5 @@ dist
node_modules
.env
wrangler.toml
-.wrwangler
\ No newline at end of file
+.wrwangler
+.DS_Store
\ No newline at end of file