Skip to content

Instantly share code, notes, and snippets.

@mediavrog
Last active May 1, 2017 08:27
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save mediavrog/442270642964b1a02e079905436c7a41 to your computer and use it in GitHub Desktop.
Save mediavrog/442270642964b1a02e079905436c7a41 to your computer and use it in GitHub Desktop.
Default Readme.me template at AIR

PROJECT_NAME

Build Status Coverage Status Coverage

Story board: https://air-en-japan.storiesonboard.com/m/__PROJECT__

Backlog https://waffle.io/en-japan-air/__PROJECT__

Design: https://projects.invisionapp.com/d/main#/projects/prototypes/__INVISION_PROJECT_ID__

Requirements

Development

Setup

** Notes on FOO**

Install XY

Install YZ

Run locally

Testing

Unit test

Integration test

Environments

Type URL
staging Manually deploys staging
production Manually deploys production

Automated Deployment

On every push to master branch (direct push or merge of pull request) travis will deploy application to staging environment. For more details see deploy section in .travis.yml.

Manual Deployment

Requirements

Deployment using XYZ

Command Description
make deploy_staging Manually deploys staging
make deploy_production Manually deploys production

DB Diagram

Notes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment