README.md

Hashly

An URL shortening service written in express

Features

1. User registration and login.
2. Shorten URLs.
3. Update and Delete shortened URLs.
4. Graph representation of number of clicks.
5. URL Analytics.
6. Page Views.
7. Unique Visitors

Getting Started

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

Prerequisites

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

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/geekcodershivam/hashly.git

2. Move to the hashly repository

cd ./hashly

3. Install all project dependency packages via NPM

npm install

4. Set up Mongodb Atlas

• If you don't have any idea about mongodb atlas you can check out from here.

5. Make .env file

 PORT=5000
 MOGOURI=" Your Mongodb url"
 JWT_SEC='keys'

6. Start the server.

nodemon

7. Move to the client folder

cd ./hashly/client

8. Install all project dependency packages via NPM

npm install

9. Runs the app .

npm start

And see it working on http://localhost:3000

API Spec

Request	End Point	Details
POST	/signup	Register User
POST	/signin	for signin
POST	/createurl	Create Url
GET	/urls	Fetch all details of urls
GET	/sh/:slug?	Redirect to Original url

Demo

Authors

Shivam Mani Tripathi