https://github.com/mugarate12/saraudapracaapi

API built in Node.JS to web and mobile application
https://github.com/mugarate12/saraudapracaapi

javascript knex mysql nodejs rest-api

Last synced: 23 days ago
JSON representation

API built in Node.JS to web and mobile application

• Host: GitHub
• URL: https://github.com/mugarate12/saraudapracaapi
• Owner: mugarate12
• Created: 2020-06-01T14:12:11.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-24T02:46:37.000Z (almost 2 years ago)
• Last Synced: 2023-03-07T23:29:28.308Z (almost 2 years ago)
• Topics: javascript, knex, mysql, nodejs, rest-api
• Language: JavaScript
• Homepage:
• Size: 886 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 20
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Sarau da praça API

- [Overview](#overview)

- [Requirements](#requirements)

- [Installation](#installation)

- [Documentation](#documentation)

- [Tests](#tests)

- [Run server](#run-server)

- [Documentation](#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](https://www.nodejs.org/)** (supported versions: 10.x.x)

- **[MYSQL](https://www.mysql.com/)**

## 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

```bash

$ npm install 

```

## Tests

you can run tests for

```bash

$ npm run test

```

## Run server

```bash

$ npm run dev

```

## Documentation

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