https://github.com/mugarate12/minhareceitaapi
A Rest API to serve a web app
https://github.com/mugarate12/minhareceitaapi
express javascript knex nodejs typescript
Last synced: 23 days ago
JSON representation
A Rest API to serve a web app
- Host: GitHub
- URL: https://github.com/mugarate12/minhareceitaapi
- Owner: mugarate12
- Created: 2020-10-16T03:31:14.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-02-12T15:31:04.000Z (about 4 years ago)
- Last Synced: 2025-03-05T14:03:14.474Z (about 2 months ago)
- Topics: express, javascript, knex, nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 700 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Minha Receita API
- [Overview](#overview)
- [Requirements](#requirements)
- [Installation](#installation)
- [Tests](#tests)
- [Run server](#run-server)
## Overview
API built on Node.JS. It's RESTful API for a Web Application.
## Requirements
- **[Node.js](https://www.nodejs.org/)** (supported versions: 10.x.x)
- **[MYSQL](https://www.mysql.com/)**
## Installation
### MySQL Configuration
1. create "minhareceitaAPI" database
2. create "minhareceitaAPI_TEST" databse
### Env variables
1. create `.env` file like `.env.example`
2. change in this file settings for a authentication to locally database
### Install all dependencies
```bash
$ npm install
```
## Tests
you can run tests for
```bash
$ npm run test
```
## Run server
```bash
$ npm start
```