https://github.com/adebola-io/quizwiz

CSC 420 Project - Quiz app. Built with React, Typescript and Tailwind.
https://github.com/adebola-io/quizwiz

css javascript nodejs quiz-game quizapp react vite

Last synced: 5 days ago
JSON representation

CSC 420 Project - Quiz app. Built with React, Typescript and Tailwind.

• Host: GitHub
• URL: https://github.com/adebola-io/quizwiz
• Owner: adebola-io
• License: mit
• Created: 2023-07-22T12:17:03.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-09T10:19:29.000Z (over 1 year ago)
• Last Synced: 2023-10-08T21:33:33.315Z (about 1 year ago)
• Topics: css, javascript, nodejs, quiz-game, quizapp, react, vite
• Language: TypeScript
• Homepage: http://quizwiz-game.vercel.app
• Size: 3.25 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
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](https://www.figma.com/file/AUoDWCLv80ZajCBgePszki/CSC-420---Project?type=design&node-id=0%3A1&mode=design&t=dHfWTuMj0kdoQkOx-1).

## 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

```shell

npm install

```

followed by

```shell

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

```shell

npm start

```

to start the Node.js server.

To see the code for the main back-end, visit [here](https://github.com/Matec12/quiz-app-backend).

## Documentation 📜

Relevant documentation files can be viewed in the [`docs`](https://github.com/adebola-io/quiz-app/tree/main/docs) folder. 

## Deployment 🚀

All pushes to the `production` branch are automatically deployed on Vercel [here](http://csc420quiz.vercel.app).