Restructure project
We previously didn't really had any structure in our project apart from creating a new folder for each package in our project root. Now that we have accumulated some packages, we use the well-known Golang project layout in order to clearly communicate our intent with packages. See https://github.com/golang-standards/project-layout
This commit is contained in:
@ -11,7 +11,7 @@ To get your local setup going, run `make bootstrap`. It will install all require
|
||||
|
||||
The project can be compiled using `make build`. This should create a binary which can then be executed.
|
||||
|
||||
Alternatively, the `go run .` command can be used to automatically compile and run the project.
|
||||
Alternatively, the `go run ./cmd/poseidon` command can be used to automatically compile and run the project.
|
||||
|
||||
### Docker
|
||||
|
||||
@ -55,7 +55,7 @@ If a value is not specified, the value of the subsequent possibility is used.
|
||||
|
||||
### Documentation
|
||||
|
||||
For the OpenAPI 3.0 definition of the API Poseidon provides, see [`swagger.yaml`](docs/swagger.yaml).
|
||||
For the OpenAPI 3.0 definition of the API Poseidon provides, see [`swagger.yaml`](api/swagger.yaml).
|
||||
|
||||
### Authentication
|
||||
|
||||
|
Reference in New Issue
Block a user