Setup of project locally

• clone repo
• npm install
• setup your local Postgres SQL database and create a database with database.sql file found in server folder
• connect the server with local db
• change config of db according to your database( please note: port in project should match your db)
• copy example from .env.example to .env file and fill in values eg: jwtSecret=password

Entry points in the app to get started adding features:

• Client folder ---> src contains all the front-end code.
• Server Folder contains all the back-end code.

Design considerations or Trade offs

• To keep with Code Your Futures brand colours
• Frontend:-
  • React Hooks - list available in package json
• Backend:-
  • bcrypt : js hashing generator
  • jsonwebtoken : used for authoration and verification
  • nodejs express : Works well with postgre sql
  • Postgres SQL: open source relational database

Features or things to add/change/remove in the future

• Replace local storage with cookies
• Add a GitHub or a different 0auth2 to register or login
• Add a registration policy for mentors (to be be clarified)
• Add a simple user profile with account settings
• Mentors view - Add a class overview of skills

Scripts

Various scripts are provided in the package file, but many are helpers for other scripts; here are the ones you'll commonly use:

• dev: starts the frontend and backend in dev mode, with file watching (note that the backend runs on port 3100, and the frontend is proxied to it).
• lint: runs ESLint against all the JavaScript in the project.
• serve: builds and starts the app in production mode locally.

Debugging

While running the dev mode using npm run dev, you can attach the Node debugger to the server process via port 9229. If you're using VS Code, a debugging configuration is provided for this.

There is also a VS Code debugging configuration for the Chrome debugger, which requires the recommended Chrome extension, for debugging the client application.

Troubleshooting

See the guidance in the wiki.