url-shortener

A REST API for shortening URLs

Requirements

• MySQL instance with database named 'shrtr' (or whatever you choose)

Installation

git clone https://github.com/panutat/url-shortener.git
cd url-shortener
npm install

Configuration

Update /config/development.json with your own MySQL credentials. Set 'cleanupAfterRestart' to false if persistence between API server restart is desired.

{
    "db": {
        "host": "127.0.0.1",
        "user": "root",
        "password": "root",
        "database": "shrtr",
        "cleanupAfterRestart": true,
        "initialAutoIncrement": 11111111
    }
}

Run development server

npm run dev

Run test

npm run test

Run linting

npm run lint