Created FAQ.md

docs/Contribution.md

@@ -0,0 +1,29 @@
+## :hugs: Welcome
+
+:+1::tada: First off, we are really glad you're reading this, because we need volunteer developers to help improve the fAIr! :tada::+1:
+
+We welcome and encourage contributors of all skill levels and we are committed to making sure your participation is inclusive, enjoyable and rewarding. If you have never contributed to an open source project before, we are a good place to start and will make sure you are supported every step of the way. If you have **any** questions, please ask!
+
+There are many ways to contribute to this repo:
+
+## Testing
+
+Adding test cases, or simply testing out existing functionality.
+
+## Report bugs and suggest improvements
+
+The [issue queue](https://github.com/hotosm/fAIr/issues) is the best way to get started. There are issue templates for BUGs and FEATURES that you can use, or you can create your own. Once you have submitted an issue, it will be assigned one label out of the following [label categories](https://github.com/hotosm/fAIr/labels). If you are wondering where to start, you can filter by the GoodFirstIssue label.
+
+## Code contributions
+
+Fork repo , Maintain your local changes on branch and Create pull requests (PRs) for changes that you think are needed. We would really appreciate your help!
+
+## Documentation contributions 
+
+Create pull requests (PRs) for changes that you think are needed to the documentation of fAIr.As of now you can find the documentation work at the [docs](https://github.com/hotosm/fAIr/tree/master/docs) directory.
+
+
+## :handshake: Thank you
+
+Thank you very much in advance for your contributions!! Please ensure you refer to our [Code of Conduct](https://github.com/hotosm/fAIr/blob/master/docs/Code-of-Conduct.md).
+If you've read the guidelines, but you are still not sure how to contribute on Github, please reach out to us via our Slack #geospatial-tech-and-innovation.

docs/FAQ.md

@@ -0,0 +1,74 @@
+# Frequently Asked Questions (FAQs)
+
+## Users
+**Q : What is fAIr?**
+
+A : fAIr is an open-source toolkit developed by the Humanitarian OpenStreetMap Team (HOT) that enables the integration of artificial intelligence (AI) into humanitarian mapping workflows. It provides AI models and tools to automate mapping tasks, improving efficiency and accuracy.
+
+<hr>
+
+**Q : How can I use fAIr in my mapping projects?**
+
+A : Building for now but to use fAIr, you can follow the installation instructions provided in the documentation. Once installed, you can utilize the pre-trained AI models for tasks such as road network extraction, building footprint detection, or land use classification. The documentation offers examples and guidelines to help you get started.
+
+<hr>
+
+**Q : What types of data can I use with fAIr?**
+
+A : fAIr primarily works with satellite imagery and aerial photographs. You can use various types of imagery sources which compiles with opensource imagery license to perform mapping tasks using the AI models provided. The documentation provides information on the compatible data formats and recommended data sources.
+
+<hr>
+
+**Q : Can I customize the AI models in fAIr for my specific needs?**
+
+A : Yes, fAIr is designed to be customizable. The toolkit provides instructions and guidelines on how to train and fine-tune models with your own datasets. This allows you to adapt the models to suit your specific mapping requirements and improve their performance on your target areas or features of interest.
+
+<hr>
+
+**Q : Are there any limitations to using fAIr?**
+
+A : While fAIr offers powerful AI models, it's important to note that the accuracy of the results may vary depending on the quality and resolution of the input imagery and the complexity of the mapping task. Some tasks may require additional manual editing or validation. It's recommended to review the documentation and understand the limitations of each model before use.
+
+<hr>
+
+**Q : How can I contribute feedback or report issues with fAIr?**
+
+A : You can contribute to the improvement of fAIr by providing feedback, reporting issues, or suggesting new features through the project's GitHub repository. By creating an issue, you can share your observations or difficulties faced while using fAIr, allowing the developers to address them and enhance the toolkit.
+
+<hr>
+
+**Q : Can I integrate fAIr with other mapping tools or platforms?**
+
+A : Yes, fAIr is designed to be modular and can be integrated into existing mapping workflows and platforms. It provides modular pip packages/ API endpoints that can be used in other scripts and can be integrated as plugins on different platforms such as Qgis, Josm etc. You can leverage the AI models from fAIr within these tools or use the outputs of fAIr in combination with other mapping datasets and tools.
+
+<hr>
+
+## Developers
+
+**Q : How can I contribute to the development of fAIr?**
+
+A : You can contribute to fAIr's development by following the guidelines provided in the project's GitHub repository. You can contribute code, suggest new features, or help improve documentation. By submitting pull requests, you can propose changes and collaborate with the project maintainers and the community.
+
+<hr>
+
+**Q : What programming languages and frameworks are used in fAIr?**
+
+A : fAIr frontend is made with React and backend with Django.fAIr is primarily developed using Python, which is widely used in machine learning and AI. It leverages popular framework TensorFlow for model development and training. Familiarity with Python and these frameworks will be beneficial if you plan to work on fAIr's development.
+
+<hr>
+
+**Q : Are there any specific coding standards or guidelines for contributing to fAIr?**
+
+A : Yes, fAIr follows coding standards and guidelines outlined in the project's repository. These guidelines cover aspects such as code formatting, documentation, and testing. Adhering to these standards helps maintain code consistency and facilitates collaboration among contributors.
+
+<hr>
+
+**Q : Can I propose new AI models or enhancements to existing models?**
+
+A : Absolutely! The fAIr project welcomes contributions related to new AI models or enhancements to existing models. If you have developed a new model that aligns with the project's goals or if you have ideas to improve the current models, you can propose them through the GitHub repository at [fAIr-utilities](https://github.com/hotosm/fAIr-utilities) and engage in discussions with the community . Once approved community will be able go use it .
+
+<hr>
+
+**Q : What kind of support can I expect as a developer contributing to fAIr?**
+
+A : As a developer contributing to fAIr, you can receive support and guidance from the project maintainers and the community. The maintainers can help address technical questions, review your contributions, and provide feedback. The community also offers a collaborative environment where you can interact with other contributors and share knowledge.

frontend/README.md

@@ -1,3 +1,5 @@
+# Frontend Deployment for Development
+
 ![example workflow](https://github.com/omranlm/TDB/actions/workflows/frontend_build.yml/badge.svg)
 ## Getting Started
 
@@ -11,10 +13,10 @@ This project is tested with Node v14.17.3 and Node v16.14.2
 
 ### Create .env file inside root dir 
 
-Put your credentials inside .env by following .env [sample](https://github.com/omranlm/TDB/blob/main/frontend/.env%20sample)
+Put your credentials inside .env by following .env [sample](https://github.com/omranlm/TDB/blob/main/frontend/.env%20sample) . 
 
 ### Start development server
 
  `npm start`
 
-#### Note : Build and Run Backend First before building frontend
+#### Note : Build and Run Backend first by following [this](https://github.com/hotosm/fAIr/blob/master/backend/README.md) before building frontend .