REAME.md Template

README.md

PROJECT NAME AND DESCRIPTION

Short introduction or overview that explains what the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.) You can also add some badges/states next to Project Name, e.g, Like:

Index

• Features or Example
  • Project good practices
• Screenshots
• Getting Started
  • Code scaffolding
  • Prerequisites
  • Installation
  • Start the development server
• Running tests
  • Unit tests
  • Running end-to-end test
• Deployment
• Contributing
• Versioning
• Authors
• License
• Acknowledgments

---

Features or Example

Talk about motivation an features of your project

Project good practices

Add any interesting thing that you may consider important to follow as a good practice for this project

Screenshots

Screen shots of tje application, if any

Getting Started

Intro about how to get stafrted with the project

Code scaffolding

Directory structure

Prerequisites

Stuff needed prior to run the project e.g, Node.js, NPM, etc

Installation

task to run before runing the server e.g, npm install , bower i , etc

Start the development server

How to run the server

Running the tests

Talk about testing

Unit test

How to run unit test

Running end-to-end test

How to run e2e test

Deployment

Things to do in order to put project on production (build process)

Built With

Just in case you want to include logos of 3rd parties

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Initial work by:

License

All Rights Reserved. Copyright