StuffEX is a full-stack application running a React.js frontend and an express backend, using MongoDB for persistant storage. To read about the product vision, check out our about page.
Style Checker: Please run npm run format from the project root before committing changes.
Linter: Please follow default configurations of ESLint
(Rules Reference: https://eslint.org/docs/latest/rules/ and Formatters Reference: https://eslint.org/docs/latest/use/formatters/)
Check out the Figma boards for UI prototypes. Last updated: 12-1-23
Here is our original [UML Diagram!] (https://github.com/KeithJLZ/csc307-stuffex/blob/main/diagram.md)
After cloning the repository, navigate to the project root and run npm install.
By default, the frontend will connect to the production backend server running on Azure. If you would like to run the frontend with your local development server, change the frontend's AppConfig.js such that backendRoot is set to http://localhost:8000 (or whichever port/host you are running a dev server on).
To run the backend, you need to set two environment variables. Set MONGODB_URI to a connection string with credentials AND specify the stuffex database in the string. You must also set TOKEN_SECRET to a string used to hash passwords.
To run either the frontend or the backend, run npm run start -w stuffex-frontend and/or npm run start -w express-backend.
Due to issues when setting up CI/CD, this is actually a fork of our original repo! Our project board is over there. Check it out
https://github.com/KeithJLZ/csc307-stuffex/blob/main/cypress/e2e/stuffex-e2e.cy.js