georio

Database and API for manaing spatial data in the imagineRio project

Requirements

• Node v7.6+ or Docker
• Yarn

Getting Started

Clone the repo and make it yours:

git clone --depth 1 https://github.com/danielfsousa/express-rest-es2017-boilerplate
cd express-rest-es2017-boilerplate
rm -rf .git

Install dependencies:

yarn

Set environment variables:

cp .env.example .env

Running Locally

yarn dev

Running in Production

yarn start

Lint

# lint code with ESLint
yarn lint

# try to fix ESLint errors
yarn lint:fix

# lint and watch for changes
yarn lint:watch

Sequelize Migrations (optional)

yarn db:migrate

# to undo the migration

yarn db:migrate:undo

Test

# run all tests with Jest
yarn test

# run unit tests with coverage
yarn test:unit

# run integration tests
yarn test:integration

# run all tests and watch for changes
yarn test:watch

Validate

# run lint and tests
yarn validate

Logs

# show logs in production
pm2 logs

Documentation

# generate and open api documentation
yarn docs

Docker

# run container locally
yarn docker:dev
or
docker-compose -f docker-compose.yml -f docker-compose.dev.yml up

# run container in production
yarn docker:prod
or
docker-compose -f docker-compose.yml -f docker-compose.prod.yml up

# run tests
yarn docker:test
or
docker-compose -f docker-compose.yml -f docker-compose.test.yml up

License

MIT License - [Axis Maps]