moonshot-chingu-quiz

Chingu Moonshot - Quiz App

This repository contains a web application for practising programming and interview questions.

Table of Contents

• Instructions
• Designs
• Code Dependencies
• Contributing
• Code of Conduct
• License

Instructions

In order to get this application running on your local development environment please download Docker and (if you're a linux user) Docker-Compose. Afterwards, follow the steps laid out below to get up and running.

First Setup

1. Fork the repository
2. Clone your forked repository onto your local machine
3. Inside your CLI (Command Line Interface), move into your working directory
4. Run npm run dev-setup inside the root folder - this will install project-wide development dependencies and start the docker development containers.

For returners

1. Run npm run dev inside the root folder to start docker development containers.

Designs

You can find the designs to this project here: https://www.figma.com/file/2mKq8rdawiJO6EEVwugWYp/Chingu_Mockups?node-id=84%3A198

If you're a designer and would like to contribute, feel free to reach out to us!

Code Dependencies

The app is built with the following code dependencies:

1. NextJS
2. Styled Components
3. Express
4. PostgreSQL

Contributing

This repository is open for contribution. For details on how to get started, check out our Contributing Guide.

Code of Conduct

Please check our code of conduct before you start contributing.

License

This repository is licensed under the GNU General Public License v3.0. Please, read this for additional information.