OKRA

README

An OKR app to manage and facilitate your company's objectives and key results between team members.

##Dependencies

• gin
• mgo
• mgo/bson
• yaml
• cli

Data Stores

• MongoDB

Installation/Set up

1. Install MongoDB.

2. In your project directory, run

go get github.com/dmonay/okra

Tests and Benchmarks

NOTE: No tests as of yet. To be added.

To run tests, run

go test

To run benchmarks, run

go test -check.b

Documentation

1. Start the server:

go run server.go server

Create your organization

POST /create/organization

Sample Request Body

NOTE: Must pass in a parameter for the organization.

{
"organization":"DopeStartup"
}

Sample Response Body

{
   "You have successfully created an organization"
}

Add an OKR tree to the organization

POST /create/tree/:organization

Sample Request Body

NOTE: Must pass in a parameter for the timeframe. One of "annual" or "monthly".

{
"timeframe":"weekly"
}

Sample Response Body

{
   "You have successfully created a tree with the annual timeframe for the DopeStartup organization"
}

Add or update mission in your tree

POST /update/mission/:organization

Sample Request Body

NOTE: Must pass in a parameter for the mission.

{
"mission":"To thrive amidst enemies"
}

Sample Response Body

{
   "You have successfully added a mission"
}