README.md

JSQuiz App

JSQuiz is for learning developers to test their knowledge and understanding of coding skills. Users can create an account and take quizzes on many different topics with varying difficulty levels. Take notes on quizzes and revisit them by going to your profile.

Table of Contents

• Installation
• Configuration
• Usage
• Credits

Installation

To run JSQuiz on your local machine, follow these steps for installation:

Back-end:

1. Clone the repository: https://github.com/Code-the-Dream-School/ee-prac-team3-back
2. Run npm install to install dependencies
3. Pull the latest version of the main branch (when needed)
4. Run npm run dev to start the development server

Front-end:

1. Clone the repository: https://github.com/Code-the-Dream-School/ee-prac-team3-front
2. Run npm install to install dependencies
3. Pull the latest version of the main branch (when needed)
4. Run npm start to start the development server

Configuration

JSQuiz can be configured using environment variables. Create a .env file in the root directory like the example file in the back-end. Copy .env.example to your .env and ask your coworkers to share the secrets with you.

Usage

JSQuiz provides a simple way for developers to take quizzes. Follow these steps:

1. Open the application in your web brower.
2. Sign in or create a personal account.
3. Browse our selection of quizzes of varying topics and difficulty levels.
4. Start a quiz and answer the questions. Use the notes feature to save a question to revisit later.
5. Receive instant feedback on your performance.
6. Save quizzes to favorites for easy access.

Credits

JSQuiz is built by 2023 React and Node alumni from Code The Dream School.

Front-End: Katsiaryna Lashcheuskaya(@katsiarynalashcheuskaya) David Greenslade(@DavidGslade86) Eva Weisneck(@evaw277)

Back-End: Alina Matskevich(@npnote8) Bangah M’Bayi Yann(@Bino26)

With special thanks to our amazing mentors:

Elijah Bernstein-Cooper(@ezbc) Sergey Sherstobitov(@in43sh)