pmyjavec / asana Goto Github PK

Further Document Asana so it's easy for those unfamiliar to the service to operate, consume etc. Documentation should:

• Talk about the goal of Asana.
• Provide instructions on how to contribute to Asana and run the tests.
• Steps for deploying Asana.
• Instructions on consuming the Asana service.

Establish a continuous integration / build pipeline for the the service and publish artifacts to the Docker registry for easy deployment down the track.

• Tests are written for components.
• Tests and builds are running out of Travis CI.
• Docker images are built and published to a public registry.

Integrate with PostgreSQL database to store Asanas or Poses with search keywrods. This allows for people to be able to search for poses based on ailments.

• Integrate Ecto into the application.
• Create the model and migration script in Ecto
• Wire up API resources to respective models in the database.
• Add search route using PostgreSQL full text search on the keywords field.

Initialize code base, spec out the API design and get a simple, very basic API up and running and responding to requests. More information about the architecture of the service can be found in the README.

Acceptance criteria:

• A simple instance of the Asana service can be started using Elixir + Plug
• API responds with some mock data.
• The API is RESTful and communicates using JSON.
• A startup script for the application is written.
• The API is documented and stubbed out.

Automated deployments using Ansible and potentially Terraform, Terraform for the life cycle management of infrastructure.

Acceptance criteria:

• The creation of any required infrastructure is fully automated.
• Ubuntu 16.04 servers are created and used for the deployment, running Docker.
• Playbooks are written to deploy and configure Nginx, PostgreSQL and any an instance of Asana.
• The configuration and deployment of new server instances is fully automated.
• Update the README with deployment instructions.