ReadMe how to

This documents aims to describe the list of topics that every readme file should have.

Topics

• Project title
• Brief description of the project
• Installation guide
• How to run the tests
• How to do the deployment
• How to contribute:
  • Code Style
  • Development process
  • Branches
  • Pull requests
  • Versinong process
• Summary of the technologies used in the project

Please keep this file updated!

Brief description of the project

Please include what does the project do, what is the main goal of the application and at least one image would be great to have.

Installation guide

How to install the application, please include all the necessary commands to fully obtain a running version as direct as possible.

As an example:

Prerequisities:

• Linux
• node.js
• PostgreSQL

Installation commands:

npm install -g strongloop
git clone repo
cd project
npm install

How to run the tests

Please explain here which testing tools and metodologies are we using and an example of how to run them.

As an example:

We are using Protractor as an e2e framework. You will need to install Protractor this way:

npm install -g protractor
webdriver-manager update
webdriver-manager start

and to run the test:

cd /tests/e2e
protractor app.js

How to do the deployment

Explain here how to do a deployment to X server, please include all the necesary details like:

• Instance minimum and recommended requirements.
• sofware needed and its version (like linux, git, etc)
• ssh key configuration to pull the repo.
• commands in order to start the server or script.
• all configuration files that are needed to be correctly created and specified.
• explain .env configuration (and Ids or dependences of external tools like cloudinary)
• DNS needed configurations
• SSL support configuration

Please also if you are aware of some issue that has happened, please include that too.

As an example: