A game of 20 words
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
The following are required installed and set up before starting this app
Git
Nodejs >= v8
Mongodb
To start this app, perform the following step in order
1. Clone this repo to your machine
2. run "npm install" on the root directory of the project
3. Make a new file named ".env" then copy the content of sample.env to the .env file you created. Edit the file to suit your environment
4. Run the command "npm start"
For easy references and development, please adhere to the style guide defined in the eslint config and editor config
Please make sure to configure your editor to follow eslint specified in this project
Refer to google style guide for further clarification
Add additional notes about how to deploy this on a live system
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
- Benjamin Eloke
See also the list of contributors who participated in this project.
see the LICENSE.md file for details