-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update README.md * Updates sequelize version
- Loading branch information
Showing
3 changed files
with
53 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,55 @@ | ||
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) | ||
[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/spinsage/community) | ||
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) | ||
|
||
# Fastify Rest API with MySQL Starter | ||
Boilerplate project for bootstrapping development of a Rest API application with NodeJS, Fastify, and MySQL | ||
|
||
# LICENSE | ||
## Getting Started | ||
|
||
### Clone the repository | ||
|
||
```console | ||
git clone https://github.com/spinsage/fastify-js-rdbms-starter-rest.git | ||
``` | ||
|
||
### Install dependencies | ||
|
||
```console | ||
npm install | ||
``` | ||
|
||
### Configure environment variables | ||
|
||
- Create a .env file by copying .env.sample. | ||
- Update environment variable values in the .env file as needed. | ||
|
||
### Run the application | ||
|
||
#### For development | ||
|
||
```console | ||
npm run start-dev | ||
``` | ||
|
||
#### For deployment | ||
|
||
```console | ||
npm run start | ||
``` | ||
|
||
#### Within a Docker container | ||
|
||
```console | ||
docker-compose up | ||
``` | ||
|
||
## LICENSE | ||
|
||
**Fastify Rest API with MySQL Starter** is Apache 2-licensed. | ||
<br><br> | ||
|
||
# Let us know! | ||
## Let us know! | ||
|
||
We at [**Spinsage**](https://www.spinsage.com/) would be happy if you send us links to your projects where you are using our code. Just send us an email at [email protected]. | ||
|
||
And do let us know if you have any queries or suggestions regarding our work. |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters