![Logo](./public/image/slugblack.png)
The URL Shortener project aims to create a service that shortens long URLs into more manageable and shareable links. The project utilizes a frontend built with React for the user interface, and a backend powered by Node.js for handling requests, interacting with a MongoDB database, and sending emails via Nodemailer.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
The URL Shortener project aims to create a service that shortens long URLs into more manageable and shareable links. The project utilizes a frontend built with React for the user interface, and a backend powered by Node.js for handling requests, interacting with a MongoDB database, and sending emails via Nodemailer.
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
This is an example of how to list things you need to use the software and how to install them.
- npm
npm install npm@latest -g
- Get a free API Key at
- Clone the repo
git clone https://github.com/360Parminder/TheSlug.git
- Install NPM packages
npm install
- Enter your API in
config.js
const API_KEY = 'ENTER YOUR API';
Users can navigate to the Slug website and find a text input field where they can paste their long URL. Upon submitting the form, the website generates a shortened URL, which users can copy and share with others.
For more examples, please refer to the Documentation
- Feature 1
- Feature 2
- Feature 3
- Nested Feature
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt
for more information.
Parminder Singh - @twitter_handle
Project Link: https://github.com/360Parminder/TheSlug