JCI

Getting Started

0. Clone the repository
1. Install the dependencies
   1. In the root directory, run npm install
   2. In the /server directory, run npm install
   3. In the /client directory, run npm install
2. Create the .env files
   1. Go to the /server directory and copy and complete the .env file
   2. Go to the /client directory and copy and complete the .env file
3. Create a session.key file in the /server directory by running cd server && npx @fastify/secure-session > session.key
4. You may need to follow the instructions at database section to create the database.
5. Start the project with npm run start (by default, the React app will be started on port 3000 and the API will be started on port 3001)

Development

The frontend is developed using React.js and Typescript in the /client directory. The backend is developed using Node.js, Fastify and Typescript in the /server directory.

Database

0. Go to the /server directory
1. With MySQL, create a database named according to the name given in the .env
2. Use npx prisma db push to apply the schema to the database
3. Use ts-node server/src/utils/fakerDatabase.ts to generate fake data