Contributing

Frontend vs Backend

🏠 Below is the structure of our project.

└───tweetbrain
    ├───backend
    │   └───app
    └───frontend
        └───src

Backend

⚒ The heavy work is done here.

└───tweetbrain
    └───backend

We are using a Python web framework called Fast API which is great for quickly creating Web APIs, including documentation.

🧠 Learn more about Fast API

All configuration files (e.g. requirements.txt) are within tweetbrain/backend, with the Fast API files within tweetbrain/backend/app.

For information about contributing to the backend

Front End

✨ The pretty work is done here.

└───tweetbrain
    └───frontend

We are using React to develop the front end (no specific framework chosen).

🧠 Learn more about React

All configuation files (e.g. package.json) are in tweetbrain/frontend, with the React.js files within tweetbrain/frontend/src.