Local Setup
This project is structured into **three separate repositories**, each serving a different role. To contribute or run the project locally, you'll need to understand how these repos relate and how to get started with each one.
Repository Overview
1. Main Repository (this one)
- Contains the documentation site and the dashboard interface.
- It is the main entry point for users to interact with our project.
- Link: Main Repo
2. Experimental Models Repository
- This is where our initial prototypes and experimental model iterations were developed.
- It contains rough drafts, early ideas, and test notebooks.
- Link: Experimental Repo
3. Backend API Repository
- Hosts the Flask server that serves model predictions via a REST API and the github actions that runs the model predictions.
- It powers the backend used by the dashboard.
- Link: Backend Server Repo
Running Locally
To run any of the components locally:
- Fork the repository you want to work with.
- Clone your forked version.
- Follow the README.md provided in each repository for local setup instructions.
Each README includes details like:
- Required dependencies
- Environment configuration
- How to start the server or application
Make sure to create virtual environments when needed and install packages using the correct requirements file.
If you're contributing to more than one part (e.g., frontend + backend), consider running each in its own terminal or workspace.