Handy readme template

README.md

Project Title

Short blurb about what your project does.

One or two short paragraph statements about your product and what it does.

Table of contents

• Usage
• Getting started
  • Prerequisites
  • Installing and running
• Running the tests
  • End to end tests
  • Coding style tests
• Deployment
• Built with
• Contributing
• Versioning
• Release history
• Meta
• License
• Known issues / bugs
• Feature roadmap
  • In the works
  • Planned
• Acknowledgements

Usage

A few motivating and useful examples of how your product can be used. Spice this up with code blocks and potentially more screenshots.

For more examples and usage, please refer to the Wiki.

Getting started

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.

Prerequisites

What things you need to install the software and how to install them

If you don't have Nodejs and npm installed, install them from here.

Give examples

Installing and Running

A step by step series of examples that tell you how to get a development env running

In the root directory:

npm install

And finally:

npm run dev

End with an example of getting some data out of the system or using it for a little demo

Running the tests

Explain how to run the automated tests for this system

Add the following section to your package.json:

{
  "scripts": {
    "test": "jest"
  }
}

End to end tests

Explain what these tests test and why

Give an example

Coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built with

• React - Front-end framework
• Nodejs - Javascript runtime
• Express - Framework used for API in Node
• PostgreSQL - Open source object-relational database

Contributing

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

1. Fork it (https://github.com/yourname/yourproject/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request

Versioning

SemVer is being used for versioning. For the versions available, see the tags on this repository.

Release history

• 0.2.1
  • CHANGE: Update docs (module code remains unchanged)
• 0.2.0
  • CHANGE: Remove setDefaultXYZ()
  • ADD: Add init()
• 0.1.1
  • FIX: Crash when calling baz() (Thanks @GenerousContributorName!)
• 0.1.0
  • The first proper release
  • CHANGE: Rename foo() to bar()
• 0.0.1
  • Work in progress

Meta

Your Name – @YourTwitter – YourEmail@example.com

Distributed under the XYZ license. See LICENSE.md for more information.

https://github.com/yourname

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Known issues / bugs

• List of most prominent
• issues or bugs

To add an issue, start a new one here.

Feature roadmap

In the works

• List features that are currently
• being worked on here

Planned

• List of features that are
• intended to be added

If you'd like to add a feature yourself, please see the Contributing guidelines.

Acknowledgements

• Hat tip to the other readme templates I synthesized
• Inspiration
• etc

---