Shortlr

by coding-blocks

GitHub Readme.md

alt text

shortlr

An URL shortening service written in express

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

  • NodeJS
  • Node Package Manager(NPM)
  • Git
  • PostgreSQL

Installing

A step by step series of examples that tell you have to get a development environment running

  1. Download ZIP file or clone the repository to create your own copy.
git clone https://github.com/coding-blocks/shortlr
  1. Move to the shortlr repository
cd ./shortlr
  1. Install all project dependency packages via NPM
npm install
  1. Set up PostgreSQL
  • If you don't have PostgreSQL setup on you machine you can download it from here.

  • After Installation is complete create a new PostgreSQL user shorturl with password as shorturl.

  • Create a new database in PostgreSQL server with name shorturl.

  1. Start the server.
npm start

And see it working on http://localhost:4000/admin

Deploying to Heroku

heroku create
git push heroku master
heroku open

Alternatively, you can deploy your own copy of the app using this button:

Deploy to Heroku

Authors

See also the list of contributors who are participating in this project.

Demo

Shortlr demo

NPM