URL Shortner is a web app which can help you to get rid of long URLs, shorten them and share them with your friends.
- Shorten you long URLs.
- Customize your URL’s Back Half.
- Share your shortened url with others.
To get a local copy up and running follow these simple steps.
In order to get a copy of the project you will require you to have Node.js (v14+) and the NPM package manager installed. If you don’t have it, you can download the latest version of Node.js from the official website which also installs the NPM package manager by default.
Open the terminal in the folder in which you wish to clone the repository and enter the following command:
git clone https://github.com/prasoonsoni/URL-Shortner.git cd backend (For Backend) cd frontend(For Frontend)
Install all the NPM packages:
In order to run the backend server:
npm i -D nodemon (One time installation) npx nodemon index.js
In order to run the frontend:
npm run start
Note that you will have to add your own
.envfile at the root directory for both frontend and backend, and add your own environment variables for the project to build.
Following are the environment variables used for backend:
MONGO_URI– The MongoDB connection string
HOST– The domain name (usually http://localhost:3000)
Following are the environment variables used for frontend:
REACT_APP_BASE_URL– The domain name (usually http://localhost:3000)
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/YourAmazingFeature)
- Commit your Changes (
git commit -m 'Add some YourAmazingFeature')
- Push to the Branch (
git push origin feature/YourAmazingFeature)
- Open a Pull Request