A program management platform for Meemli, an organization providing pro-bono tutoring services to students. Meemli has asked us to consolidate and simplify their student attendance workflow. This application allows for program and student management in one centralized interface. Administrative users can assign teachers and restrict visibility only to their respective courses. Teachers can track their students' progress, mark attendance, and leave comments on their performance.
Before starting development, make sure you have these tools installed:
- Node.js - this is our JS runtime
- Npm - this is our package manager
- Postman - helpful for testing API routes
- MongoDB Community - necessary if you want to run database locally
Add the .env.frontend and .env.backend from the project google drive to their respective directories in your local branch.
cd backend- Run
npm installto install all dependencies - If running the database locally, make sure to start mongod
npm run startto start the backend
If this works properly you should see a message in the terminal saying > Listening on port 4000
cd frontend- Run
npm installto install all dependencies - Run
npm run devto start development server - Server is started on port 3000. Follow this url and you should see the development page.
Run these commands in the backend or frontend directories for linting and formating. Be sure to run these commands before pushing to github.
npm run lint-fix- fixes all auto-fixable lint errors and reformats codenpm run lint-check- check all lint errors or code style issues without modifying any files