Skip to content

Latest commit

 

History

History
75 lines (52 loc) · 2.56 KB

README.md

File metadata and controls

75 lines (52 loc) · 2.56 KB

Stories in Ready Stories in Progress Needs Review Build Status Coverage Status Go Report Card license

You can see progress on tasks at http://waffle.io/devopsdays/gather-flag

Throughput Graph

gather-flag

gather-flag is a web application for organizing open spaces, built with ❤️ by mattstratton in Go.

Requirements

  • Docker 1.12
  • Docker Compose 1.8

Starting services

docker-compose up -d

Stopping services

docker-compose stop

Including new changes

If you need change some source code you can deploy it typing:

docker-compose build

That being said, things should reload on the fly.

Documentation

Topic Service

This service is used to get information about a topic. It provides the topic title, the description, and other details.

Routes:

  • GET - /topics : Get all topics
  • POST - /topics : Create topic
  • GET - /topics/{id} : Get topic by id
  • DELETE - /topics/{id} : Remove topic by id

Account Service

This service is used to manage user accounts, specifically around login, etc.

Routes

  • GET - /accounts : Get all accounts
  • POST - /accounts: Create account
  • GET - /accounts/{id} : Get account by id
  • DELETE - /accounts/{id} : Remove account by id

Room Service

This service manages rooms, including who has access to them, etc

Routes

  • GET - /rooms : Get all rooms
  • POST - /rooms : Create new room
  • GET - /rooms/{i} : Get room by id
  • DELETE - /rooms/{i} : Remove room by id