GitXplorerGitXplorer
H

dokerb

public
1 stars
0 forks
2 issues

Commits

List of commits on branch main.
Verified
bb98faafb926d3440d94dbd020a2484d30bb8f88

Merge pull request #16 from HaRo87/feature/refactor-rest-api

HHaRo87 committed 4 years ago
Unverified
02270af4ac8a37471896233fc58d6c414631c7f0

fixing swagger doc and left over comments

HHaRo87 committed 4 years ago
Unverified
9732e66ab873b1e775ffe304626e6dc7bac4494c

Renamed WorkPackage to Task

HHaRo87 committed 4 years ago
Verified
08b4764113d19b2ac70f079ca51db5b3eac67120

Merge pull request #13 from HaRo87/feature/docker

HHaRo87 committed 4 years ago
Unverified
2460fef9ad0961e75dd36e8b67789c9cfe7cc588

Docker task cmds

HHaRo87 committed 4 years ago
Unverified
fe94999d32dc7deb370749aef0b73c9e481b5a79

Added Docker documentation

HHaRo87 committed 4 years ago

README

The README file for this repository.

Delphi Planning Poker (Doker) Backend

DokerB Logo

Testing Go Code codecov

go version license

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

  1. This projects uses
  1. 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.