Template React Express

Quick description

Run Locally

Clone the project

 git clone [Project url]

Go to the project directory

cd [Project Name]

Install backend dependencies and build the front-end

 yarn build

Start the back-end

 yarn back:start

Start the front-end

 yarn front:start

URLs :

Server URL : http://localhost:2000/api

Built version of front-end : http://localhost:2000

Live version of front-end : http://localhost:3000

Deployment

To deploy this project run

 pm2 deploy ecosystem.json production

Check if you can access to the server before trying to deploy.

API Reference

API Documentation : [Postman]([Postman documentation url])

Environment Variables

To run this project, you will need to add the following environment variables to your .env file and your ecosystem.json file (It's recommended to use the example files provided in the repo : .env.example)

Environment variables : Github env

NODE_ENV=""PORT=""TZ=""JWT_SECRET=""MONGO_URL=""

Tech Stack

Client: React, typescript, tailwindcss

Server: Node, typescript, express, bcryptjs, jsonwebtoken

Contributors

Lucas Stoebner 💻

Félix Legrelle 💻