README
¶
MADR
We have a site for this project!
Check it out: madr.space
How to start the service
Docker (recommended, everything is set up)
alias swagger='docker run --rm -it --user $(id -u):$(id -g) -e GOCACHE=/tmp -e GOPATH=$(go env GOPATH):/go -v $HOME:$HOME -w $(pwd) quay.io/goswagger/swagger'
swagger generate spec -o ./swagger.yaml --scan-models
docker-compose up --build
By default, service is available at http://localhost:8080.
Manually (not recommended)
- Install go-swagger. It's necessary since the service uses swagger-generated file for hosting documentation.
- Run
make runin the root of the project.
Documentation
Service documentation is available at /api/docs after starting the service.
By default, it's available at http://localhost:8080/api/docs. It contains a rich description of endpoints and models.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
api-server
command
Package main is the entry point for the API server.
|
Package main is the entry point for the API server. |
|
internal
|
|
|
data
Package data provides the data access layer for the application.
|
Package data provides the data access layer for the application. |
|
flashcards/cache
Package cache provides simple access to in-memory cache.
|
Package cache provides simple access to in-memory cache. |
|
flashcards/models
Package models provides entities for the flashcards services
|
Package models provides entities for the flashcards services |
|
flashcards/services/deck
Package deck provides the model of decks containing flashcards.
|
Package deck provides the model of decks containing flashcards. |
|
flashcards/services/study
Package study provides the services for testing and studying flashcards according to Leitner's system.
|
Package study provides the services for testing and studying flashcards according to Leitner's system. |
|
flashcards/storage
Package storage provides the interface containing methods that access the database and return values.
|
Package storage provides the interface containing methods that access the database and return values. |
|
handlers
Package handlers provides the HTTP handlers for the API server.
|
Package handlers provides the HTTP handlers for the API server. |
|
ioutil
Package ioutil provides functions for IO operations.
|
Package ioutil provides functions for IO operations. |
|
models
Package models provides the data models for the application.
|
Package models provides the data models for the application. |
|
social/models
Package models provides entities for the social services
|
Package models provides entities for the social services |
|
social/storage
Package storage provides the interface containing methods that access the database and return values for groups and other socials.
|
Package storage provides the interface containing methods that access the database and return values for groups and other socials. |
Click to show internal directories.
Click to hide internal directories.