Skip to content

arnulfojr/scrum-estimations-api

Repository files navigation

Estimations API

Build Status CodeFactor

Estimations API allows people to self host their scrum estimations service. Allows full support for different values to use for estimating a task or ticket.

In order to be able to estimate a task there's some requirements:

  • An organization is created
  • All users must have an organization
  • A session has to be created and is related to an organization
  • A session can have multiple tasks to be estimated
  • A user can then estimate tasks from the session

Getting the API docs

Estimations API delivers the API docs in Swagger 2.0 through the /docs/api/v1.json. The Swagger docs can be visualized in the Swagger UI editor.

Running tests

Running locally

$ make run

Running the linting

$ make lint

Running API tests

$ make api-tests

Contact

Arnulfo Solis arnulfojr94@gmail.com