Skip to content

Latest commit

 

History

History
166 lines (114 loc) · 3.96 KB

README.md

File metadata and controls

166 lines (114 loc) · 3.96 KB

📝 Memory Nomads ❓

Badge Badge Badge Badge Badge


Tech Stack :

  • Frontend: HTML,CSS,React.js
  • Version Control: Git and GitHub
  • Hosting: Netlify
  • Code Editor and tools: VS Code

✨ Welcome to Memory Nomads ✨

Table of Contents

- Overview
- Folder Structure
- UI of Website
- Contribution Guideline

Overview 🔨

Memory Nomads is an online quiz web application. Which have three different types of quiz categories. In each category, you can read rules, play a quiz, and check your result at the end.

Folder Structure 📒

├───assets
│   └───Images
├───backend
│   ├───controllers
│   ├───db
│   └───utils
├───components
│   ├───categories
│   ├───current-question
│   ├───footer
│   └───navbar
├───contexts
├───pages
│   ├───categories-page
│   ├───homepage
│   ├───quiz-page
│   ├───result-page
│   └───rules-page
└───reducers

UI of the Website

Click on the image to watch it.

Screenshot (126) Screenshot (127)
Home Page Quiz Category Page
Screenshot (128) Screenshot (129)
- -
Rules Page Questions Page
Screenshot (130)
Result Page

Setup Steps

  • Go to directory
$ cd Quiz-App
  • Start LocalHost Server
npm install
npm run start


Contribution Guidelines 🏗

To start contributing, follow the below guidelines:

1. Fork this repository.

2. Clone your forked copy of the project.

git clone https://github.com/ishitakeshawani/Quiz-App.git

3. Navigate to the project directory 📁 .

cd Quiz-App

4. Add a reference(remote) to the original repository.

git remote add upstream Quiz-App.git

5. Check the remotes for this repository.

git remote -v

6. Create a new branch.

git checkout -b <your_branch_name>

7. Perfom your desired changes to the code base.

8. Track your changes:heavy_check_mark: .

git add .

9. Commit your changes .

git commit -m "Relevant message"

10. Push the committed changes in your feature branch to your remote repo.

git push -u origin <your_branch_name>

11. To create a pull request, click on compare and pull requests.

12. Add appropriate title and description to your pull request explaining your changes and efforts done.

13. Click on Create Pull Request.

14 You did it! 🥳 Wait for your submission to be accepted and your PR to be merged.