README.md

Delphi Planning Poker (Doker) Backend

 

The idea behind Doker is to have a web based service which allows developers to kinda play Planning Poker but using the Delphi Method for effort estimates.

⚡️ Quick start

1. Clone this repository

2. Install the prerequisites

• Go
• Task
• Swag

3. This projects uses

• Fiber
• Create Go App
• fiber-swagger

4. Run project by this command:

task -s

I am using Taskfile as task manager for running the project on a local machine by default.

Then you should be able to navigate to http://127.0.0.1:<port> where port is defined by your config file -> default is 5000.

This should display the general info page which also provides links to further documentation and the Swagger documentation. You can then use either the interactive Swagger documentation or a tool like HTTPie for trying out the API.

Creating a new session should be as simple as running:

http POST http://127.0.0.1:5000/api/sessions

to create a new session where the response should look something like:

{
    "message": "ok",
    "route": "/sessions/eaf27c59ecdf0db4e165c4f940e176ec"
}

Then you can also do things like adding a user:

http POST http://127.0.0.1:5000/api/sessions/eaf27c59ecdf0db4e165c4f940e176ec/users name="Tigger"

which should produce an output like:

{
    "message": "ok",
    "route": "/sessions/eaf27c59ecdf0db4e165c4f940e176ec/users/Tigger"
}

⚙️ Configuration

# ./configs/apiserver.yml

# Server config
server:
  host: 0.0.0.0
  port: 5000

# Database config
database:
  location: my.db

# Static files config
static:
  prefix: /
  path: ./static

Docker Container

In case you want to run DokerB in a Docker container you can use the Dockerfile located inside the backend directory.

There are also two tasks specified in the taskfile. You can run:

task docker-build

for building the Docker image and:

task docker-run

for running the Docker container, assuming you did not change the default config it will expose the correct port.

⚠️ License

MIT © HaRo87.