Additional information or tag line
A brief description of your project, what it is used for.
Installing / Getting started
Install NPM-Modules via
$ npm install # OR $ yarn
This install the required node_modules. Then run
# Development initialization $ npm run init # Develop-Mode with file-watch $ npm run dev # Copy HTML-Assets and Images $ npm run uiimages && npm run htmlassets # Build for production $ npm run build
List main libraries, frameworks used including versions (React, Angular etc...)
What is needed to set up the dev environment. For instance, global dependencies or any other tools. include download links.
Setting up Dev
Here's a brief intro about what a developer must do in order to start developing the project further:
git clone https://github.com/your/your-project.git cd your-project/ packagemanager install
And state what happens step-by-step. If there is any virtual environment, local server or database feeder needed, explain here.
If your project needs some additional steps for the developer to build the project after some code changes, state them here. for example:
./configure make make install
Here again you should state what actually happens when the code above gets executed.
Deploying / Publishing
give instructions on how to build and release a new version In case there's some step you have to take that publishes this project to a server, this is the right time to state it.
packagemanager deploy your-project -s server.com -u username -p password
And again you'd need to tell what the previous code actually does.
Here you should write what are all of the configurations a user can enter when using the project.
Describe and show how to run the tests with code examples. Explain what these tests test and why.
Give an example
Explain your code style and show how to check it.
If the api is external, link to api documentation. If not describe your api including authentication methods as well as explaining all the endpoints with their required parameters.
Explaining what database (and version) has been used. Provide download links. Documents your database design and schemas, relations etc...
State what the license is and how to find the text version of the license.