Doc: Update readme and add community sample directory (#21)

* doc(readme): add react sample URL reference * doc(community): add community sample directory and readme file * doc(community): update dir name and fix typos
getdozer · Apr 26, 2023 · 7bcea6e · 7bcea6e
1 parent b7bb901
commit 7bcea6e
Show file tree

Hide file tree

Showing 2 changed files with 73 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -34,7 +34,7 @@ Refer to the [Installation section](https://getdozer.io/docs/installation) for i
 | Use Cases        | [Flight Microservices](./usecases/pg-flights)                            | Build APIs over multiple microservices.                                      |
 |                  | Use Dozer to Instrument (Coming soon)                                    | Combine Log data to get real time insights                                   |
 |                  | Real Time Model Scoring (Coming soon)                                    | Deploy trained models to get real time insights as APIs                      |
-| Client Libraries | Dozer React Starter (Coming soon)                                        | Instantly start building real time views using Dozer and React               |
+| Client Libraries | [Dozer React Starter](./usecases/react/)                                        | Instantly start building real time views using Dozer and React               |
 |                  | [Ingest Polars/Pandas Dataframes](./client-samples/ingest-python-sample) | Instantly ingest Polars/Pandas dataframes using Arrow format and deploy APIs |
 | Authorization    | Dozer Authorziation (Coming soon)                                        | How to apply JWT Auth on Dozer APIs                                          |
 
@@ -45,7 +45,7 @@ Refer to the [Installation section](https://getdozer.io/docs/installation) for i
 Refer to the following for an exhaustive list of configuration samples.
 | Reference                                                       | Notes                               |
 | --------------------------------------------------------------- | ----------------------------------- |
-| [Connectors](https://getdozer.io/docs/configuration/connectors) | Sample connnector config references |
+| [Connectors](https://getdozer.io/docs/configuration/connectors) | Sample connector config references |
 | [SQL](https://getdozer.io/docs/sql/introduction)                | Sample SQL using Dozer              |
 
 
@@ -58,4 +58,3 @@ Please refer to [Contributing](https://getdozer.io/docs/contributing/overview) f
 - [Documentation](https://getdozer.io/docs/dozer/)
 - [Architecture](https://getdozer.io/docs/dozer/architecture)
 - [Discord channel](https://discord.gg/3eWXBgJaEQ)
-
diff --git a/community-samples/README.md b/community-samples/README.md
@@ -0,0 +1,71 @@
+# Dozer Sample Contribution Guidelines
+
+Thank you for your interest in contributing to the dozer-samples! This document outlines the guidelines and best practices to follow when submitting a community project. We appreciate your effort and look forward to collaborating with you.
+
+## Contribution Process
+
+1. **Fork** the [dozer-samples](https://github.com/getdozer/dozer-samples/) repository on GitHub.
+2. **Clone** your forked repository to your local machine.
+3. **Create** a new branch with a descriptive name related to your project (e.g., `my-awesome-project`).
+4. **Add** your project files to the `community-samples` directory within the repository.
+5. **Commit** your changes and **push** them to your forked repository.
+6. **Submit** a Pull Request (PR) from your forked repository to the `main` [dozer-samples](https://github.com/getdozer/dozer-samples/) repository.
+
+## Project Structure
+
+Please structure your project as follows:
+
+```bash
+community-samples/
+    ├── your-project-name/
+    │   ├── your-project-file_1/
+    │   ├── your-project-file_n/
+    │   ├── README.md
+    │   └── LICENSE
+    └── ...
+```
+
+
+- **README.md**: A Markdown file providing a detailed description of your project, installation instructions, usage, and any other necessary information.
+- **LICENSE**: A text file specifying the license under which your project is distributed.
+
+
+## Pull Request (PR) Template
+
+When submitting a PR, please include the following information:
+
+```markdown
+### Project Name
+
+*Short description of your project*
+
+### Project Description
+
+*Provide a more detailed description of your project, its purpose, and how it works*
+*You can also add architecture diagram if you have any*
+
+### Features
+
+- List of key features or highlights of your project
+- Add as many bullet points as needed
+
+### Installation & Usage
+
+*Provide detailed instructions for installation and usage of your project*
+
+### License
+
+*Specify the license under which your project is distributed*
+
+### Checklist
+
+- [ ] I have read the contribution guidelines
+- [ ] I have provided a README.md with detailed information about my project
+- [ ] I have provided all necessary assets (if applicable)
+- [ ] I have included the LICENSE file in my project
+
+```
+
+By following these guidelines and using the provided PR template, you'll have a smooth review process and timely integration of your project into the [dozer-samples](https://github.com/getdozer/dozer-samples/) repository.
+
+Thank you for your contribution! 🤗 🙏