Team Hack Slash
-
Fork and clone the project.
-
Populate
.env
file inside/backend
directory with your credentials. Check.env.example
for its contents. -
Run
npm run repopulate-db:local
to populate db with fake data for local development. -
Run
npm install:all
in the project root folder (not working 100% on Windows). If you wish to install and run only backend or frontend part of the app, thencd
into that folder and runnpm install
. For example:cd backend && npm install
. -
Then to run app (from root folder) in dev mode:
npm run dev
. If you prefer to run backend in one terminal and frontend in another, then executenpm run dev:backend
in one andnpm run dev:frontend
in another. -
By default backend server is running on port 3001 and frontend on port 3000. So they are accessible at
http://localhost:3001
andhttp://localhost:3000
.
-
Student Tracker wireframes on Figma. Initial MVP + wireframes for future enhancements of the app.
-
Initial MVP user stories + user stories for future enhancements. File here.