Zoronium/quiz-webapp-server

Backend for the live quiz web app platform!

Quiz-webapp-server

=> Backend for the live quiz web app platform!

Links

👨🏻‍💻Contributing

📚Important Guidelines

➡ API

⚙🖥Deployment

Contributing

Contributions are always welcome!

See Contributing for ways to get started.

Please adhere to this project's code of conduct.

Step 1: Fork the repository

Fork this repository by clicking on the fork button on the top of this page. This will create a copy of this repository in your account.

step 2: Clone Repo

Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

Open a terminal and run the following git command:

git clone https://github.com/mlsacbvp/quiz-webapp-server.git

Step 2: Go to issues tab

Go to the MLSAC project repository => In the Issues section => Choose an issue you think you can resolve => Comment that you want to work on it.

Step 3: Sync changes

If the issue is assigned to you, you can work on it and send a PR within 2-3 days after syncing new changes.

Important guidelines

1. Without any assigned issue, don’t send a PR, and if you don’t find issues at a particular time, then visit the repo after 2-3 days.
2. If you send a PR without being assigned an issue, your PR will be marked “spam” or “invalid”.
3. After getting assigned an issue, you must send a PR within 2-3 days otherwise we will re-assigning that issue to someone else.

**Read the official hacktoberfest guidelines:**👇🏻👇🏻👇🏻

https://hacktoberfest.com/participation/#pr-mr-details https://hacktoberfest.com/participation/#spam

More Resources 📚

1. What is Hacktoberfest
2. How to Use git
3. how-to-contribute
4. first-contributions
5. awesome-for-beginners
6. github-git-cheat-sheet
7. How to Write Good Commit Messages
8. How to Do Your First Pull Request? (video)

## API Reference

Get all items

  POST /register

Parameter	Type	Description
name	string	Required. Your name
username	string	Required. Your username
email	email	Required. Your email
password	string	Required. Your password

Get item

  POST /login

Parameter	Type	Description
username	string	Required. Your username
password	string	Required. Your password

Profile

  Get /profile

Header	Type	Description
Authorization	string	Required. JWT TOKEN from login

Run Locally

To run this project Please Do the following steps:-

Clone the project

  git clone https://github.com/mlsacbvp/quiz-webapp-server.git

Go to the project directory

  cd quiz-webapp-server

SetUp ENV variables

for this just copy the data from .env.sample to .env file

for linux/Mac

touch .env
cat .env.sample >> .env

for win

Copy-Item -Path .\.env.sample
-Destination .\.env -PassThru

Install dependencies

  npm install

SetUP MongoDB

  use users
  show dbs

Start the server

  node app.js

OR

  nodemon app.js