Simple overview of use/purpose.
An in-depth paragraph about your project and overview of use.
- Describe any prerequisites, libraries, OS version, etc., needed before installing program.
- ex. Windows 10
- How/where to download your program
- Any modifications needed to be made to files/folders
- To run this project follow these steps ,
- clone the repo using
git clone
- run
npm install
to instal node modules - run
npm start
to start the service onlocalhost:3000
- clone the repo using
- How to run the program
- Step-by-step bullets
code blocks for commands
Any advise for common problems or issues.
command to run if program contains helper info
Contributors names and contact info
ex. Keyvan Shabani
- 0.2
- Various bug fixes and optimizations
- See commit change or See release history
- 0.1
- Initial Release
This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details