Shortening URL APP

App to shortening URL, developed with Nodejs, Express, MongoDB with the help of mongoose

Basic guide to use the App.

Installation

Use need NodeJS to use this, clone the repo and install the dependencies.

https://github.com/abduljeleelng/shortening-url.git

Install the dependencies

npm i

set your environmental variable

# default DB URI if 'NODE_ENV' not set 
MONGO_URI=mongodb://127.0.0.1:27017/short-url

# DB URI for production server  
MONGO_PRO=

# DB URI for testing - to mockup data
MONGO_TEST=mongodb://127.0.0.1:27017/short-test

# DB URI for dev environment
MONGO_DEV=mongodb://127.0.0.1:27017/short-dev

# App Port
PORT=9000

# This variable "must" set when we want to run "test" 
# 'dev' for dev environment 
# 'pro' for dev production 
# 'test' for test environment, This must set to run test and mock with mongo schema 
NODE_ENV=dev

# The domain  
BASE_URL=

Run the development version of the App

npm run dev

Rebuild documentation

npm run docs

Run Automated test

npm run test

Build for production

npm run build

Start the application

npm start

Live Endpoint

Shortening-URL

Documentation

Documentation

Contact Me

AbduljeleelNG
email : abduljeleelng@gmail.com