desert3agle / url-shortner-api

Sho-rt : A minimal URL shortner, built using NodeJS, Express and MongoDB.

URL Shortner API

A minimal URL shortner. feel free to use this as server side of your application.

API Documentation - Docs

You can:

• shorten urls
• access shortened urls

Built With

• NodeJS - evented I/O for the backend
• Express - framework for backend
• Mongoose - ODM
• MongoDB - Database
• Swagger - API Documentation

Getting Started

These instructions will get your copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

you need to have NodeJs and MogoDb installed on your local machine.

Installation

To install NodeJs 12.xx and MongoDb 4.x

$ chmod +x install.sh
$ ./install.sh

Install dependencies

$ npm install

Set up environment variables

$ cp .env.template .env

Local Run

Provide correct values in .env and proceed with local run

$ npm start

Deployment

Heroku Deployment

$ heroku login -i
$ heroku git:remote -a <your-app-name>
$ git push heroku master

Set up environment variables

$ heroku config:set ENV_VAR=<value>

Authors

• Harsh Vardhan - Initial work - desert3agle