Skip to content

Commit

Permalink
Doc/readme updates (#4)
Browse files Browse the repository at this point in the history
* Update README.md

* Updates sequelize version
  • Loading branch information
spinsager authored Jan 3, 2022
1 parent 13c458d commit 4a692aa
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 11 deletions.
48 changes: 45 additions & 3 deletions README.md
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.
14 changes: 7 additions & 7 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"fastify-sequelize": "^1.0.4",
"mysql2": "^2.3.3",
"pino-pretty": "^7.3.0",
"sequelize": "^6.12.0-alpha.1",
"sequelize": "^6.12.4",
"uuid": "^8.3.2"
},
"devDependencies": {
Expand Down

0 comments on commit 4a692aa

Please sign in to comment.