This boilerplate was built for larger projects that would require more complex structuring.
This README file is just a template, true app details should be filled in as necessary.
Few lines describing your project.
Write about 1-2 paragraphs describing the purpose of your project.
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.
What things you need to install the software and how to install them.
Give examples
A step by step series of examples that tell you how to get a development env running.
Say what the step will be
Give the example
And repeat
until finished
End with an example of getting some data out of the system or using it for a little demo.
Explain how to run the automated tests for this system.
Explain what these tests test and why
Give an example
Explain what these tests test and why
Give an example
Add notes about how to use the system.
Add additional notes about how to deploy this on a live system.
- React JS - Web Framework
- MongoDB - Database
- Express - Server Framework
- NodeJs - Server Environment
- etc...
- @peyssoa -> Idea & Initial work
- Hat tip to anyone whose code was used
- Inspiration
- References