Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prasoonsoni/url-shortner
Having long URLs ??? No Problem, Shorten them now.
https://github.com/prasoonsoni/url-shortner
expressjs mongodb nodejs portfolio reactjs url-shortener
Last synced: about 1 month ago
JSON representation
Having long URLs ??? No Problem, Shorten them now.
- Host: GitHub
- URL: https://github.com/prasoonsoni/url-shortner
- Owner: prasoonsoni
- License: mit
- Created: 2022-06-07T16:39:47.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-27T16:28:49.000Z (over 1 year ago)
- Last Synced: 2024-05-28T22:14:26.242Z (7 months ago)
- Topics: expressjs, mongodb, nodejs, portfolio, reactjs, url-shortener
- Language: JavaScript
- Homepage: https://bitwiz.me
- Size: 387 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
URL Shortner 🔗
Having long URLs ??? No Problem, Shorten them now. 💡
Explore the docs »
•
Report Bug
•
Request Feature
•
## 
About The Project
URL Shortner is a web app which can help you to get rid of long URLs, shorten them and share them with your friends.
## 
Features
* Shorten you long URLs.
* Customize your URL's Back Half.
* Share your shortened url with others.
## 
Tech Stack
* React.js
* Node.js
* Express.js
* MongoDB
* JavaScript
## 
Screenshots
## 
Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
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](https://nodejs.org/en/download/) which also installs the NPM package manager by default.
### Installation
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:
```
npm i
```
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 `.env` file 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)
## 
Contributing
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**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/YourAmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some YourAmazingFeature'`)
4. Push to the Branch (`git push origin feature/YourAmazingFeature`)
5. Open a Pull Request
## 
Contact
### Prasoon Soni
[`E-Mail`](mailto:[email protected])
[`LinkedIn`](https://www.linkedin.com/in/prasoonsoni/)