Compass by Tabiya is an AI chatbot designed to assist job-seekers in exploring and discovering their skills.

Compass has two objectives:

• Populate a digital skill wallet that captures the experience of job-seekers, including the skills inherent in their formal and informal work.
• By doing so, guide job-seekers in exploring and discovering their skills and interests based on their lived experiences.

Table of Contents

• Backend: Explore the Backend directory for detailed insights about the backend project.

• Frontend(POC): Explore the Frontend directory for detailed insights about the old, temporary chat app. This is a proof of concept and is not the final product, but can be used to test the backend.

• Frontend(New): Explore the Frontend(New) directory for detailed insights about the new frontend project. This project is still a work in progress.

• Infrastructure As Code (IaC): Explore the Infrastructure as code(IAC) directory for detailed insights about the infrastructure-as-code components.

• Sensitive Data Protection: Explore the sensitive data protection functionality for detailed insights about how we are safeguarding sensitive personal data.

Contribution Guidelines

🎉 Thank you for considering contributing to Tabiya Compass! 🎉

Conventional Commits

Please follow the Conventional Commits format for your commit messages.

Getting Started

To work with this repository you should have a system with a bash compatible terminal (linux, macOS, cygwin) as most of the scripts are written for bash and will not work on windows cmd or powershell.

1. Fork the repository and clone it to your local environment.

2. Create a new branch for your changes.

3. Set up each individual subproject. e.g. if you are working on backend/ follow instructions in backend/README.md

4. After making your changes, ensure the code is clean, properly formatted and passes all tests.

   You can use the provided script, run-before-merge.sh, for assistance. This script performs checking of the code formatting, linting, building, and testing on the subprojects of the repository. To run it, use the following command:

   ./run-before-merge.sh

   If you get any errors, fix them before proceeding. A common source of errors is not fully completing step 3 from above.

5. Commit them, and push to your fork.

6. Use descriptive commit messages following Conventional Commits.

7. Open a pull request to our main branch.

Happy contributing! 🚀

License

This project is licensed under the MIT License. See the LICENSE file for more information.

Funders and Partners