An open source RESTFUL API quiz questions for popular programming languages. It consists of Multiple Choice Questions(MCQs) in various areas including: HTML, CSS, JavaScript, NextJs etc.
- Documentation: https://quizbase.netlify.app
- Demo App: https://app-quizs.netlify.app/login
- Postman Documentation: https://documenter.getpostman.com/view/9434341/2s93Y3v1bu
- NodeJs 14.17.5 - A cross-platform JavaScript runtime environment for developing server-side applications
- Express 4.18.2 - A NodeJs web application framework that helps manage servers and routes.
- Mongoose ^7.0.0 - A non-relational Database
- Eslint ^7.32.0 || ^8.2.0 - Handles codebase Linting, (Eslint standard used)
- Prettier ^2.8.4 - Code formatter to to make code base look pretty
- Husky ^8.0.3 and lint-staged ^13.2.0 - Pre-commit hooks that runs on
git commit
.husky
node_modules/
documentation/
src/
--config
--config.js
--logger.js
--controllers/
--auth.js
--quiz.js
--contributor.js
--routes/
--auth.js
--quiz.js
--contributor.js
--index.js
--user.js
--models/
--quiz.js
--user.js
--contributor.js
--middlewares/
--error-handler.js
--token
--db/
--db.js
--utils/
--sendEmail
--templates
--index.ejs
--emailhandler.js
--responseHandler.js
app.js
server.js
.env-example
package.json
- Make sure you have nodejs v14.17.5 installed by running the following command below. You can install nodejs from here if you don't have it.
- To check node version
node --version
- Clone the respository to your local machine using the command
git clone https://github.com/sandygudie/quiz-api.git
- Navigate to the project folder.
- And open the project with your code editor (VScode recommended)
- Install the package dependencies by running the following command in the terminal
yarn install
- Create a
.env
in the project folder, get variables from the.env.example
file sample and ensure to add the values(e.g MONGODB_URI) - To start the server locally, run the command
yarn run dev
- Navigate to the documentation folder.
cd documentation
- Install Packages
yarn install
- To start documentation locally, run the command
yarn start
- We're using
eslint
for js linting, andprettier
for code formatting. - Please make it a point to install
eslint
andprettier
plugins on vscode to aid in your coding process. - Run the command to fix all auto-fixable formatting errors in the whole project based on
eslint
rulesyarn run lint
- Run the command to check and fix file formatting with
prettier
yarn run format
- Also Linting has been set up for staged commits in the project.
- Application is on auto deploy from Github to Render.
- You can contribute to adding questions for the project login
- If you like the project, leave your star.
- If you would like to complain/suggest/contribute to this project, feel free to open a issue 💟