Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
spinsager authored Jan 3, 2022
1 parent 1d76098 commit 5687748
Showing 1 changed file with 45 additions and 3 deletions.
48 changes: 45 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,56 @@
[![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)

# Express Rest API with MySQL Starter

Boilerplate project for bootstrapping the development of a Rest API application with NodeJS, Express, and MySQL

# LICENSE
## Getting Started

### Clone the repository

```console
git clone https://github.com/spinsage/express-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

**Express 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 opensource@spinsage.com.

And do let us know if you have any queries or suggestions regarding our work.

0 comments on commit 5687748

Please sign in to comment.