README.md

Event Manager Project

Event manager uese RESTful APIs using Node.js, Express and Sequelize

Requirements

• Node v7.6+
• Yarn

Getting Started

Install dependencies:

yarn

Set environment variables:

cp .env.example .env

Running Locally

yarn dev

Running with Docker Componse

docker-compose up

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

Test

# run all tests with Mocha
yarn test

# run unit tests
yarn test:unit

# run integration tests
yarn test:integration

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

# open nyc test coverage reports
yarn coverage

Validate

# run lint and tests
yarn validate

Logs

# show logs in production
pm2 logs

Documentation

POSTMAN: https://documenter.getpostman.com/view/1662461/Tzm2JJ72

OR

# generate and open api documentation
yarn docs

Tutorials

• Create API Documentation Using Squarespace

License

MIT License - Muhammad Ndako