The master monorepo for all OreCart app software! The OreCart app includes a backend made with FastAPI, an admin dashboard built with React/Vite, and a crossplatform mobile app made with React-Native.
For full documentation and project details, please see the Google Drive (ask leads for access) and orecart.github.io. The frontend, frontend-admin, and backend folders have READMEs with more information about developing in each as well.
For this project you will need Docker, Node.js, and Python 3.
We use docker compose to make running the application consistent and simple.
To start the application run: docker compose up.
If you want to run it in the background run: docker compose up -d.
If you want to rebuild the docker containers run: docker compose build.
To start the application in a development mode (it will restart when files are saved) run: docker compose watch.
These commands should be ran at the root level of the project.
Contributors (aka "The OreCart Team") must be approved by the current OreCart/leads team. Outside contributors are not allowed unless explicit approval is granted by leads.
Do not push code directly to main -- the branch is locked for this anyways! Please use branches for each new feature and submit a pull request when ready. Branch names should be short but descriptive, and all lowercase.
Each pull request requires a minimum of two relevant reviewers (leads or team members) for approval and merging.
Any references to Colorado School of Mines (aka "Mines", "CSM"), Innov8x, or official OreCart brand identity are used with permission for this project, however, this project is not owned by Mines or Mines ACM itself. See the LICENSE for more details.