Run the project and read the instructions.
-
Clone the current repository.
-
Create a branch correctly named as "LASTNAME_FIRSTNAME".
-
Move into the
backend
directory and copy the.env.sample
file to create your.env
file. This one is not committed to the shared repository. Fill your backend.env
with your database credentials. TheDB_NAME
can stay as checkpoint3. You may have to changeAPP_PORT
if the port 5000 is not available. -
Move into the
frontend
directory and copy the.env.sample
file to create your.env
file. This one is not committed to the shared repository. Fill your frontend.env
with the url of your backend. In particular, adapt the port if your port 5000 is not available. -
Execute the following commands from the root folder of the project to start:
# Install dependencies
npm run setup
# Create 'checkpoint3' DB
cd backend
npm run migrate
cd ..
Launch the project with the command below and follow the instructions on the homepage http://localhost:3000/
;
npm run dev
setup
: Initialization of frontend and backend, as well as all toolingsdev
: Starts both servers (frontend + backend) in one terminaldev-front
: Starts the React frontend serverdev-back
: Starts the Express backend serverlint
: Runs validation tools, and refuses unclean code (will be executed on every commit)fix
: Fixes linter errors (run it iflint
growls on your code !)