https://github.com/kafkasl/tir-library
Section of Tir's Library containing book entries and reviews from registered scholars.
https://github.com/kafkasl/tir-library
Last synced: about 2 months ago
JSON representation
Section of Tir's Library containing book entries and reviews from registered scholars.
- Host: GitHub
- URL: https://github.com/kafkasl/tir-library
- Owner: kafkasl
- License: apache-2.0
- Created: 2019-06-11T18:25:46.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-08-01T14:34:28.000Z (almost 6 years ago)
- Last Synced: 2024-04-28T05:16:41.334Z (about 1 year ago)
- Language: Go
- Homepage:
- Size: 217 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tir-library
Section of Tir's Library containing book entries and reviews from registered scholars.
### Build
To build the application binary just issue:
`go build -o bin/tir-library -v .`
### Run
In order to run the application you need to define your Postgres configuration in a `.env` at the root of the project.
It is recommended to copy the file `sample.env` and replace the values. Testing environmnet deletes all DB entries
before running the application so be careful not to use it with a production / development DB.
Once you have the `.env` run with:
`./bin/tir-library`
### Tests
#### Postman
Currently tirlib is tested against postman requests collection. You can run them with the provided script:
`./run_tests.sh`
or manually if the application is already running:
`newman run tests/tir-library.postman_collection.json`
Requires newman installed: (`npm install -g newman`):
#### Golang
Golang tests are under construction. They must be improved to use the auth middleware as currently they bypass it.
Moreover, the access to the DB from concurrent tests are not dealt with.
### API Documentation
The REST API documentation can be found [here](tirlibrary.docs.apiary.io).