Project Name

Pithy project description

Team

• Product Owner: W1: Burk, Nathan
• Scrum Master: W1: Nathan, David
• Producer: W1: David, Burk

Table of Contents

1. Usage
2. Requirements
3. Development
   1. Installing Dependencies
   2. Tasks
4. Team
5. Contributing

Usage

Some usage instructions

Requirements

• Node 7.7x
• MongoDB 9.1.x
• etc
• etc

Development

Installing Dependencies

From within the root directory:

sudo npm install -g yarn
yarn install / yarn (equivalent to npm install)

##Yarn cmds
-__Adding a dependency__-
yarn add [package]
yarn add [package]@[version]
yarn add [package]@[tag]

-__Upgrading a dependency__-
yarn upgrade [package]
yarn upgrade [package]@[version]
yarn upgrade [package]@[tag]

-__Removing a dependency__-
yarn remove [package]

To build the apk:

From within the client directory: http://ionicframework.com/docs/v1/guide/publishing.html

cordova build --release android
*** Creates the unsigned apk ***

keytool -genkey -v -keystore my-release-key.keystore -alias alias_name -keyalg RSA -keysize 2048 -validity 10000
*** Generates key for signing apk ***
### Roadmap

View the project roadmap [here](LINK_TO_PROJECT_ISSUES)


## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.