Project setup, documentation and pull request template

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,37 @@
+<!--
+Hello 👋 Thank you for submitting a pull request.
+
+To help us merge your PR, make sure to follow the instructions below:
+
+- Create or update the documentation. (Should be made against the `main` branch)
+- Create or update the tests.
+- Refer to the issue you are closing in the PR description - fix #issue
+- Specify if the PR is in WIP (work in progress) state or ready to be merged
+
+Please ensure you read through the Contributing Guide:
+https://github.com/joschan21/profanity.dev/blob/main/CONTRIBUTING.md
+-->
+
+## 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.

.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

README.md

@@ -0,0 +1,111 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/PKief/vscode-material-icon-theme/ec559a9f6bfd399b82bb44393651661b08aaf7ba/icons/folder-docs.svg" width="100" alt="project-logo">
+</p>
+<p align="center">
+    <h1 align="center">PROFANITY.DEV</h1>
+</p>
+<p align="center">
+    A fast, free and open-source profanity filter for your web apps
+</p>
+
+## Overview
+
+<details>
+  <summary>Table of Contents</summary><br>
+
+-   [ Overview](#-overview)
+-   [ Getting Started](#-getting-started)
+    -   [ Installation](#-installation)
+    -   [ Usage](#-usage)
+    -   [ Tests](#-tests)
+-   [ Project Roadmap](#-project-roadmap)
+-   [ Contributing](#-contributing)
+-   [ License](#-license)
+-   [ Acknowledgments](#-acknowledgments)
+</details>
+
+### 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.
+
+<details closed>
+<summary>Contributing Guidelines</summary>
+
+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/<your-github-user>/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!
+ </details>
+
+<details open>
+<summary>Contributor Graph</summary>
+<br>
+<p align="center">
+   <a href="https://github.com{/joschan21/profanity.dev/}graphs/contributors">
+      <img src="https://contrib.rocks/image?repo=joschan21/profanity.dev">
+   </a>
+</p>
+</details>
+
+## 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)

tensor-api/.gitignore

@@ -1,4 +1,5 @@
 .env
 node_modules
 .wrangler
-wrangler.toml
+wrangler.toml
+.DS_Store

vector-api/.gitignore

@@ -2,4 +2,5 @@ dist
 node_modules
 .env
 wrangler.toml
-.wrwangler
+.wrwangler
+.DS_Store