https://github.com/avalos010/url_shortener
Simple URL Shortener (FastAPI + SQLite)
https://github.com/avalos010/url_shortener
fastapi python url-shortener
Last synced: about 1 month ago
JSON representation
Simple URL Shortener (FastAPI + SQLite)
- Host: GitHub
- URL: https://github.com/avalos010/url_shortener
- Owner: avalos010
- Created: 2025-07-13T21:07:52.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-07-13T23:59:49.000Z (12 months ago)
- Last Synced: 2025-07-14T01:34:10.659Z (12 months ago)
- Topics: fastapi, python, url-shortener
- Language: Python
- Homepage:
- Size: 5.86 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🔗 Simple URL Shortener (FastAPI + SQLite)
A simple and minimal URL shortener built with [FastAPI](https://fastapi.tiangolo.com/) and [SQLite](https://www.sqlite.org/index.html).
## ✨ Features
- Shorten long URLs into compact, shareable links
- Store shortened URLs in a local SQLite database
- Retrieve the original URL using the shortened link
## 🚀 Getting Started
### 1. Clone the Repository
```bash
git clone https://github.com/avalos010/url_shortener.git
cd url_shortener
```
### 2. Create a Virtual Environment
```bash
python -m venv .venv
```
### 3. Activate the Virtual Environment
#### On Linux/macOS
```bash
source .venv/bin/activate
```
#### On Windows
```bash
.venv\Scripts\activate
```
### 4. Install Dependencies
```bash
pip install -r requirements.txt
```
### 5. Run the Application
```bash
uvicorn app.main:app --reload
```
## 📡 API Endpoints
### POST `/shorten`
Shortens a long URL.
**Request Body:**
```json
{
"original_url": "https://www.example.com"
}
```
**Response:**
```json
{
"shortened_url": "https://your-url-shortener.com/abc123"
}
```
---
### GET `/redirect/{shortened_url}`
Retrieves the original URL from a shortened one.
**Example Request:**
```
GET https://your-url-shortener.com/abc123
```
**Response:**
```json
{
"original_url": "https://www.example.com"
}
```
## 🗃️ Database
- The application uses a SQLite database for storage.
- The database file is named `urls.db` and is located in the project root directory.
## 🪪 License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## 🤝 Contributing
Contributions are welcome!
If you'd like to contribute:
1. Fork the repository
2. Create a feature or fix branch
3. Submit a pull request
## 🙏 Acknowledgments
- Built using [FastAPI](https://fastapi.tiangolo.com/)
- Project structure inspired by the official FastAPI documentation