Sarau da praça API

• Overview
• Requirements
• Installation
• Documentation
• Tests
• Run server
• Documentation

Overview

API built on Node.JS. It's a RESTful API for a WEB and mobile applications for management a cultural event and subscription of participants.

Requirements

• Node.js (supported versions: 10.x.x)
• MYSQL

Installation

MySQL Configuration

1. create "sarauapidevelopment"
2. create "sarauapitest"

Env variables

1. create .env file like .env.example
2. change in this file settings for a authentication to locally database
3. besides including gmail settings you make this changes in gmail configuration(Google Account -> Security)

Install all dependencies

$ npm install 

Tests

you can run tests for

$ npm run test

Run server

$ npm run dev

Documentation

Documentation is present after run server, in localhost:{PORT}/docs and you see this: