Awesome
Agile Visitors API
API for the application that registers visiting employees.
Table of content
Get Started
$ git clone https://github.com/itsalb3rt/agile-visitors-api.git
$ cd agile-visitors-api
Now copy and rename the .env.example file.
$ cp .env.example .env
By default, the project is ready for use with docker
$ docker-compose up -d postgres
# wait few seconds before run next command
$ docker-compose up -d agile-visitors-api
Now you have the API running in http://localhost:5000/api or http://local.agile-visitors.api/api
ENV file
The env file contains a series of variables that modify the behavior of the API.
# API
PORT=5000
# Database
DATABASE_HOST=localhost
DATABASE_PORT=5444
DATABASE_NAME=postgres
DATABASE_USER=postgres
DATABASE_PASSWORD=postgres
# Sequelize
FORCE_SYNC=true # Create tables from models
Development
For development
$ npm run dev
Build
For created a production version
$ npm run build
Run Production
$ npm run start
Filters and More
Query string
Filters
between
For example for check createdAt from 2020-09-01 to 2020-09-30.
api/visits?createdAt=between:2020-09-01,2020-09-30
Like
For using like operator you can pass search query string var with where for indicate columns.
api/visits?search=some&where=reasonVisit
This search for some in reasonVisit column.
Limit and offset
You can use limit and offset for pagination.
api/visits?limit=10&page=2
This example returns the records between 11 to 20
Order
Use - sign for descending while + for ascending, by default if sign is not presented it will automatically set to + sign (ex: sort=-created_at or sort=+created_at). Value can be separated by a comma if multiple sort condition is needed (ex: sort=id,name).
api/visits?sort=-created_at
More information: https://github.com/perbert27/sequelize-querystring-converter
License
This project uses the following license: MIT