README.md

Quiz Web App

This is the repository for Group 3 of the CSC 420 Software Engineering project.

Design 🖌

The design for this project is hosted on Figma here.

Development 🖥

Front-end

The front-end is written using React, Typescript and Tailwind. Node and NPM/Yarn must be installed to preview it. To run the frontend locally, cd into the frontend/ folder and run

npm install

followed by

npm run dev

to start the local dev server.

Back-end

A simple development back-end is present in the /backend/mock/ folder. To run it, cd into the folder and run:

npm install

and then

npm start

to start the Node.js server.

To see the code for the main back-end, visit here.

Documentation 📜

Relevant documentation files can be viewed in the docs folder.

Deployment 🚀

All pushes to the production branch are automatically deployed on Vercel here.