Bridge-In-Tech (backend)

Bridge-In-Tech is an application that allows industries/companies, mentors and students to actively collaborate to one another.

This is the backend client of Bridge-In-Tech-Web.

Setup

To start contributing to the project, setup the backend environment on your local machine by following the instructions on the BIT Development Environment Setup Instruction wiki page.

If you prefer to test the latest approved and merged version of the project on the remote server, you can use the BridgeInTech Heroku Swagger UI server that already connected to the modified version of Mentorship System heroku backend server made specifically for BridgeInTech development.

Branches

This repository has the following branches:

master: This branch contains the deployment of the backend.
develop: This contains the latest code. All the contributing PRs must be sent to this branch.

Auto-formatting with black

We use Black to format code automatically so that we don't have to worry about clean and readable code. To install Black:

pip install black

To run black:

black .

Project Documentation

Documentation for the project is hosted here. We use Docusaurus for maintaining the documentation of the project.

This project has live documents that contain information on:

Planning - BridgeInTech Proposal Review
Technical Discussion and Decision made throughout the development
Meeting Minutes

For a more complete information on BridgeInTech project, please go to BridgeInTech Backend Wiki page.

Contributing

This project is under active development

Please read our Contributing Guidelines, Code of Conduct and Reporting Guidelines thoroughly.

Contributors

Thanks goes to these people (emoji key):

_{Maya Treacy}
🚧 💻 📖 📓 ⚠️

_{Roshni Pattath}
🚧

_{Rahul Mohata}
💻 📖 🧑‍🏫 👀

This project follows the all-contributors specification. Contributions of any kind welcome!

Contact

If you have any questions or want to discuss something about this repo, feel free to join our Zulip Community! If you are a new contributor, head over to this project's stream #bridge-in-tech on Zulip to see ongoing discussions.

License

The project is licensed under the GNU General Public License v3.0. Learn more about it in the LICENSE file.

anitab-org / bridge-in-tech-backend

readme