Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thiiagoms/scalable-api-alura

Scable API with NodeJs + Alura :blue_heart:
https://github.com/thiiagoms/scalable-api-alura

alura api-alura node-api node-mysql

Last synced: about 2 months ago
JSON representation

Scable API with NodeJs + Alura :blue_heart:

Awesome Lists containing this project

README

        



Logo
Logo
Logo

API with Node and Alura! :hearts:

- [Dependencies](#Dependencies)
- [Usage](#Usage)

### Dependencies
- Git
- NodeJs LTS
- MySQL
- API Rest Client (Postman, Insomnia, etc)

### Usage

1 - Clone:
```bash
$ git clone [email protected]:thiiagoms/scalable-poc-api-alura
```

2 - Change `credentials` in `config/default.json`:
```json
{
"mysql": {
"databaseName": "[DATABASE-NAME]",
"databaseUser": "[DATABASE-USER]",
"databasePass": "[DATABASE-PASS]",
"databaseHost": "[DATABASE-HOST]"
},
"api": {
"PORT": [API-PORT-HERE]
}
}
```

3 - Run migrations:
```bash
$ npm run migrate
```

4 - Stand up server
```bash
$ npm run dev
Listening on http://localhost:[YOUR-API-PORT] or Listening on http://localhost:8000
```