https://github.com/mohammadrezaamani/lincut
Lincut is a simple yet powerful Link Shortener service built with FastAPI. It allows you to shorten long URLs into concise, user-friendly links.
https://github.com/mohammadrezaamani/lincut
fastapi link-shortener pythpn sqlalchemy
Last synced: about 1 month ago
JSON representation
Lincut is a simple yet powerful Link Shortener service built with FastAPI. It allows you to shorten long URLs into concise, user-friendly links.
- Host: GitHub
- URL: https://github.com/mohammadrezaamani/lincut
- Owner: MohammadrezaAmani
- License: mit
- Created: 2023-01-15T20:20:09.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-06T22:19:23.000Z (over 2 years ago)
- Last Synced: 2025-01-13T11:12:21.968Z (over 1 year ago)
- Topics: fastapi, link-shortener, pythpn, sqlalchemy
- Language: Python
- Homepage:
- Size: 56.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Lincut - FastAPI Link Shortener
Lincut is a simple yet powerful Link Shortener service built with FastAPI. It allows you to shorten long URLs into concise, user-friendly links.
## Features
- Shorten long URLs with ease.
- Generate customizable and memorable short links.
- View statistics on the usage of your links.
- API for easy integration with other applications.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [API Documentation](#api-documentation)
- [Configuration](#configuration)
- [Contributing](#contributing)
- [License](#license)
## Installation
1. Clone the repository:
```bash
git clone https://github.com/yourusername/lincut.git
```
2. Install the required dependencies using pip:
```bash
pip install -r requirements.txt
```
3. Configure your database settings and other options in the `config.py` file.
4. Start the FastAPI application:
```bash
python -m lincut
```
Lincut will be available at [http://localhost:8000](http://localhost:8000).
### Usage
Access the Lincut web interface at [http://localhost:8000](http://localhost:8000) or your deployed server.
Enter the long URL you want to shorten.
Optionally, customize the short link or leave it to be auto-generated.
Click the "Shorten" button to generate the short link.
You can also view statistics for each short link on the dashboard.
API Documentation
Lincut provides a simple and easy-to-use API for link shortening and statistics retrieval. The API documentation can be found at http://localhost:8000/docs, powered by Swagger UI. This documentation provides details on all available API endpoints and request/response formats.
### Configuration
The config.py file allows you to configure various aspects of the Lincut service, including database settings, custom short link patterns, and more. Be sure to review and update this file to suit your specific requirements.
### Contributing
We welcome contributions to Lincut! If you would like to contribute, please follow these guidelines:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and ensure the code is well-documented.
- Run tests to make sure your changes haven't broken existing functionality.
- Submit a pull request with a clear description of the changes and the problem they solve.
### License
Lincut is open-source software released under the `MIT` License. You are free to use, modify, and distribute it as you see fit.
If you have any questions, feedback, or issues to report, please don't hesitate to open an issue on this GitHub repository.