Smahrt / node-url-shortener

A url shortener built using Node JS

Trim

---

The Trim Link Shortener and Sharing Tool is what identify and engage your audience.

Not just a link shortener but branded and can track engagements.

---

Features

• Shorten urls.
• Count number of clicks.
• Share links to social media.

---

Getting Started

Below are instructions to kick start AutoMart in your local server.

First off, you must have node/npm installed. Install the latest node version here. Not to worry, the npm package comes along with the node package

Installation

1. Clone this repository by running this on your terminal: git clone https://github.com/hngi/node-url-shortener.git
2. Navigate to the project's directory with: cd node-url-shortener
3. Run npm install to install dependencies
4. You will need to connect to the database using the .env.example
5. Run npm run start-dev to start the server on a local host
6. Run npm test to test.

Test Driven

Tests are written with mocha, chai-http and chai.

This will be the file and folder structure

src
├── config
       ├── constants.js  
├── controllers  
├── database
├── helpers  
├── middlewares 
├── models 
├── routes   
├── services  
├── tests  
└── views                     

---

Stack:

• Bootstrap
• Node
• Mongodb

License

ISC License