Skip to content

Instantly share code, notes, and snippets.

@pietrop

pietrop/README.md

Last active May 6, 2020 14:29
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 pietrop/a89d96870b843c6f07b8ad12a9c17dde to your computer and use it in GitHub Desktop.
Save pietrop/a89d96870b843c6f07b8ad12a9c17dde to your computer and use it in GitHub Desktop.
Download ZIP
README template
Raw
README.md

Brief of the project

One liner + link to confluence page

Screenshot of UI - optional

Setup

stack - optional

How to build and run the code/app

Usage

System Architecture

High level overview of system architecture

Development env

How to run the development environment

Coding style convention ref optional, eg which linter to use

Linting, github pre-push hook - optional

Build

How to run build

Tests

How to carry out tests

Deployment

How to deploy the code/app into test/staging/production

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