Explain backend application repo with comprehensive README - Githubissues

gunadarma-academy / asde-michi

Michi Team, including Arlin app, for ASDE course (created by Classroom for GitHub)

http://arlin.link

Other

2 stars 4 forks source link

Explain backend application repo with comprehensive README #23

Closed mhaidarhanif closed 8 years ago

mhaidarhanif commented 8 years ago

Kind: Statement of Work
Title: Explain application repo with comprehensive README
Author: M Haidar Hanif
Affiliation: Michi
Date: 2016-03-23
Version: 0.1
SOW

Overview

We need to understand the application repo (asde-michi-app), by just reading the comprehensive README. Things like:

What it is (including resources).
How to install dependencies, run the project, develop with git, or deploy it to server.
Tasks
[x] Edit README to have Getting Started section
- Installation
- Running
- Development
- Deployment
[x] Link to technical documentation in parent repo (asde-michi).
Deliverables

Every technical team member is able to understand the above purpose.

Dependencies

Tidy up various submodules (https://github.com/gunadarma-academy/asde-michi/issues/21).