https://github.com/igmrrf/querty_quiz

https://github.com/igmrrf/querty_quiz

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/igmrrf/querty_quiz
• Owner: igmrrf
• Created: 2020-10-22T21:58:52.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-12-15T05:37:54.000Z (over 1 year ago)
• Last Synced: 2025-01-06T16:48:12.983Z (5 months ago)
• Language: JavaScript
• Size: 1.1 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# QWERY QUIZ

## Tool Stack

1. MongoDB

2. Express.js

3. React.js

4. Node.js

## PROJECT SETUP

Open your terminal and run the following commands to get your copy of the projct running on your local or remote environment

#### `git clone https://github.com/igmrrf/querty_quiz`

### Environmental Variables

created a .env file in the root folder of the project and another in the client folder

There's are .env.example files in both folder, copy the information and fill them appropriately

### Dependencies

#### `yarn install`

Installs Dependencies and Dev-dependencies required to run the project successfully

Run the command on the root folder, then `cd client` and run the command again

After which you can run either of the available scripts that fit your purpose

    SERVER DEPENDENCIES

    "dependencies":{

        "body-parser": "^1.19.0",

        "cors": "^2.8.5",

        "dotenv": "^8.2.0",

        "express": "^4.17.1",

        "express-async-errors": "^3.1.1",

        "mongoose": "^5.10.9",

        "winston": "^3.3.3"

    }

    CLIENT DEPENDENCIES

    "dependencies": {

       "axios": "^0.20.0",

        "react": "^16.14.0",

        "react-dom": "^16.14.0",

        "react-router-dom": "^5.2.0",

        "react-scripts": "3.4.3",

        "react-simple-keyboard": "^2.5.9",

        "use-sound": "^1.0.2"

    },

    "devDependencies": {

        "concurrently": "^5.3.0"

    }

## Available Scripts

In the project directory, you can run:

        "scripts": {

            "client": "cd client && yarn start",

            "server": "nodemon index.js",

            "build": "cd client && yarn run build",

            "dev": "concurrently --kill-others-on-fail \"yarn server\" \"yarn client\"",

            "start": "node index.js",

            "start:dev": "nodemon index.js",

            "heroku-postbuild": "cd client && yarn install && yarn install --only=dev --no-shrinkwrap && yarn run build"

        },

### `yarn start`

Runs the app in the development mode.


Open [http://localhost:3333](http://localhost:3333) to view it in the browser.

The page will reload if you make edits.


Edit the files as you see fit, if you end up with something you cannot resolve and wish to go back to the original code. Run

`git restore`.


You will also see any lint errors in the console.

### `yarn build`

Builds the app for production to the `build` folder.


It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.


Your app is ready to be deployed!

You can deploy your project to heroku or use a CI/CD service through Github or any VCS hub.

### SERVER DOCUMENTATION

Visit [Postman Documentation](https://documenter.getpostman.com/view/9425614/TVYF7y5y)