Skip to content

Latest commit

 

History

History
55 lines (35 loc) · 2.68 KB

README.md

File metadata and controls

55 lines (35 loc) · 2.68 KB
Raw

Custom URL Shortener

version PRs Welcome

A custom URL shortner service built using ExpressJS, MongoDB & Nginx.

Operating Instructions

Local Development

Prerequisites

  • Make sure you have
    • Docker installed

Fork

  • Fork this repository
  • Download or clone your forked repository
    • You can clone the repository executing below command in a location of your choice of your system. $ git clone https://github.com/YourGitHubUserName/custom-url-shortener.git
  • That's it your almost done, now in the repository root, run the following command $ cd custom-url-shortener/, this will take you to project directory.

Using Docker

  • Make sure you have docker installed before proceeding.
    • In project-directory ./custom-url-shortener, run the following command
      • docker-compose up --build -d
    • Running docker-compose in detached mode
  • As soon as the build completes you are all set to get started with custom-url-shortener.
  • Now you have successfully setup custom-url-shortener,
    • Please find the api-documentation for application server here.
    • It describe all routes that define the operation the application server.
  • To access shortened URL visit
    • http://<docker-machine-ip>:/<UNIQUE_URL_CODE>

Suggest Features

Is a feature you care about currently missing? Make sure to browse the issue tracker and add your ":+1:" reaction to the issues you care most about, as we also use those reactions to prioritize issues.

Contributing

There are multiple ways to contribute to this project, read about them here.

JustStarIt

🌟 Star this repo if custom-url-shortener helped you.

License

All versions of the app are open-sourced, read more about this LICENSE.