This is a URL shortener application. It allows users to shorten long URLs by create short, unique URL that redirects to the original long URL. This is a URL shortener application that consists of both a backend and a frontend component. The backend is built using TypeScript with NestJS, while the frontend is built using JavaScript with Next.js.
Shorten long URLs to create concise and easily shareable links.
Redirect users to the original long URL when they access the shortened URL.
Track the number of times a shortened URL has been accessed.
User-friendly interface for managing and creating new shortened URLs
| Section | Technology |
|---|---|
| Backend |   |
| Frontend |    |
| Database |  |
| API | RESTful API endpoints |
| Authentication |
Follow these steps to set up and run the app:
Clone the repository.
Navigate to the backend directory.
cd backend
Install the dependencies by running npm install.
npm install
Set up the database (This project uses PostgreSQL as the default database).
Setup the environment variables: a .env.example file is included the root of the backend directory, it contains all the environment variables needed for the backend. Create a .env file and copy the contents of the .env.example to the just create .env file.
Start the backend server by running npm run start.
npm run start
Navigate to the frontend directory.
cd frontend
Install the dependencies by running npm install.
npm install
Setup the environment variables: a .env.example file is included in the root of the backend directory, it contains all the environment variables needed for the backend. Create a .env file and copy the contents of the .env.example to the just create .env file.
Start the frontend server by running npm run dev.
npm run dev
Once the application is set up and running, follow these steps to use the application:
Access the frontend application by visiting the provided URL.
Register an account or log in to an existing account.
Go to your dashboard
Use the interface to create a shortened URL by providing the original URL and an alias.
Copy the shortened URL and share it with others.
When users visit the shortened URL, they will be redirected to the original long URL.
Use the dashboard to view analytics, such as the number of clicks, for each shortened URL.
Contributions are welcome! If you'd like to contribute to this project, please follow these steps:
Fork the repository.
Create a new branch for your feature or bug fix.
Implement your changes and ensure they are properly tested.
Commit and push your changes to your forked repository.
Submit a pull request, clearly explaining the changes you've made.
This project is under the MIT license. See the LICENSE for more information.
The logo used in this project was created by crywill from Noun Project