Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomdieu/url-shortener
TrrxUrl is a web app use to Shorten your long URLs quickly and easily
https://github.com/tomdieu/url-shortener
next-auth next14 nextjs13 prisma prisma-orm trixurl url-shortener
Last synced: about 1 month ago
JSON representation
TrrxUrl is a web app use to Shorten your long URLs quickly and easily
- Host: GitHub
- URL: https://github.com/tomdieu/url-shortener
- Owner: Tomdieu
- Created: 2023-09-08T20:51:42.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-11-08T17:19:58.000Z (about 2 months ago)
- Last Synced: 2024-11-08T18:19:19.579Z (about 2 months ago)
- Topics: next-auth, next14, nextjs13, prisma, prisma-orm, trixurl, url-shortener
- Language: TypeScript
- Homepage: https://trixurl.vercel.app/
- Size: 2.88 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Trix URL Shortener
[](https://wakatime.com/badge/user/7a03d500-b310-4adb-9229-1bb6044d565d/project/6d51eb0b-4525-4bd4-9a57-9015ee8c05d6)
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Demo](#demo)
- [Installation](#installation)
- [Usage](#usage)
- [Technologies Used](#technologies-used)
- [Contributing](#contributing)
- [License](#license)
## Introduction
This is a URL shortener web application built with Next.js, Prisma, and PostgreSQL. It allows users to shorten long URLs into easily shareable and manageable links.
## Features
- Shorten long URLs into compact, user-friendly links.
- Track the number of clicks on each shortened link.
- User registration and authentication for managing links.
- Admin dashboard for viewing link analytics.
- Easy-to-use and responsive user interface.
## Demo
You can access a live demo of the application at [https://trixurl.vercel.app/](https://trixurl.vercel.app/).
## Installation
To run the application locally, follow these steps:
1. Clone this repository:
```bash
git clone https://github.com/tomdieu/url-shortener.git
```
2. Navigate to the project directory:
```bash
cd url-shortener
```
3. Install dependencies:
```bash
npm install
```
4. Create a .env.local file in the root directory and add your environment variables, including your PostgreSQL database connection details, API keys, and other necessary configurations.
5. Run the development server:
```bash
npm run dev
```
6. Open your browser and access the app at `http://localhost:3000`.
## Usage
- Register or log in to your account.
- Shorten a URL by pasting it into the input field and clicking "Shorten."
- View and manage your shortened links.
- Access link analytics and click statistics.
## Technologies Used
- `Next.js 14`
- `Prisma`
- `PostgreSQL`
- `Tailwind CSS`
- `Authentication: NextAuth.js`
- `Deployment: Vercel`
## Contributing
Contributions are welcome! Please refer to the `Contribution Guidelines` for details on how to contribute to this project.
## License
This project is licensed under the `MIT License`.