diff --git a/.gitignore b/.gitignore index a1338d6..935b1b5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,14 +1,21 @@ -# Binaries for programs and plugins -*.exe -*.dll -*.so -*.dylib +# Tools. +.DS_Store +.vscode +.idea +debug +glide.lock -# Test binary, build with `go test -c` -*.test +# Project directories. +build +dist +vendor -# Output of the go coverage tool, specifically when used with LiteIDE -*.out +# Project files. +app +nemt-portal-api +nemt-portal-api.log -# Project-local glide cache, RE: https://github.com/Masterminds/glide/issues/736 -.glide/ +# Configuration and stuff. +config.toml +jenkins-ebs +*.mwb.bak diff --git a/README.md b/README.md index 5e23cb1..5a0bcd7 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,31 @@ -# svijetlastrana -jah +# nemt-portal-api + +API to integrate the member application of Q-Rides + +## Documentation + +The documentation for the project structure and definitions are in +[`./docs/wiki`][wiki-doc], and the API documentation, written in Swagger/OpenAPI +2.0 YAML format, can be found in [`./docs/swagger`][swagger-doc] and visualized +and interacted at `http://dev.nemt-portal-api/v1/nemt-portal-api/docs/` + +## Running + +To execute with Docker on your machine, run `make run-loc`; for an execution +without a container, directly in the OS, run `make run-host`. + +For a deep undestanding of the `Makefile` instructions, see its +[documentation][make-doc]. + +## Creating a new project + +For now, you have to execute this in your terminal (replacing `nemt-portal-api` with +your project's name): + +``` +git clone --depth 0 git@bitbucket.org:nemt/nemt-portal-api.git nemt-portal-api +``` + +[wiki-doc]: https://bitbucket.org/nemt/nemt-portal-api/tree/master/docs/wiki +[swagger-doc]: https://bitbucket.org/nemt/nemt-portal-api/tree/master/docs/swagger +[make-doc]: https://bitbucket.org/nemt/nemt-portal-api/blob/master/docs/wiki/04%20-%20Makefile.md