valenciadev74 / url-shortener Goto Github PK

This project is a simple URL shortener created to familiarize myself with TypeScript. It allows you to shorten long URLs and share them with others more easily.

• Shortens long URLs to shorter, more memorable URLs.
• Displays the original URL when the short URL is clicked.
• Soon: Tracks the number of clicks on each short URL.

• Node.js 16+
• npm or yarn

1. Clone the repository:

git clone https://github.com/valenciaDev74/url-shortener.git

2. Navigate to the project directory:

cd url-shortener

3. Install the dependencies:

npm install || yarn install

1. Start the dev server:

npm run dev || yarn dev

2. Access the application in your web browser:

http://localhost:3000

1. Compile to Javascript:

npm run dev || yarn dev

1. Enter the URL you want to shorten in the text field.
2. Click the "Shorten" button.
3. You will be shown a short URL. You can copy it and share it with others.

The project is implemented using TypeScript and the following libraries:

• Express: Web framework for Node.js
• MongoDB: NoSQL database to store shortened URLs (optional)

Contributions to this project are welcome. If you find a bug or have a suggestion, please create an issue on GitHub.

This project is under the MIT license.