Categorygithub.com/golangid/menekel
modulepackage
0.0.0-20200923052610-adc7e29cf36b
Repository: https://github.com/golangid/menekel.git
Documentation: pkg.go.dev

# README

menekel

menekel /'m(ə)n(ə)k(ə)l/ stands for : menej artikel is a sample of article management services build from Golang.

Index

Contribution

You can file an issue or submit a Pull Request

Testing

Integration Test

$ make test

Unit Test

$ make unittest

Run The Project

# Dockerize the app
$ make docker

# Create the config file
$ cp config.toml.example config.toml

# run the project
$ make run

# Migrate the schema
$ make migrate-prepare
$ make migrate-up

Now the application should be active. Try to access it.

$ curl http://localhost:9090/articles

# Packages

No description provided by the author
No description provided by the author
No description provided by the author

# Variables

ErrBadParamInput will throw if the given request-body or params is not valid.
ErrConflict will throw if the current action already exists.
ErrInternalServerError will throw if any the Internal Server Error happen.
ErrNotFound will throw if the requested item is not exists.

# Structs

Article
Article represent the Article contract.

# Interfaces

ArticleRepository represent the repository contract.
ArticleUsecase represent the usecase of the article.