Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kramber1024/url-shortener-api
🔗 API for URL Shortener
https://github.com/kramber1024/url-shortener-api
api bitly crud database docker fastapi python rest restful-api short-url sqlalchemy swagger url-shortener
Last synced: 7 days ago
JSON representation
🔗 API for URL Shortener
- Host: GitHub
- URL: https://github.com/kramber1024/url-shortener-api
- Owner: kramber1024
- License: mit
- Created: 2024-07-17T14:21:30.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-11-04T14:12:14.000Z (11 days ago)
- Last Synced: 2024-11-04T15:24:03.965Z (11 days ago)
- Topics: api, bitly, crud, database, docker, fastapi, python, rest, restful-api, short-url, sqlalchemy, swagger, url-shortener
- Language: Python
- Homepage: https://github.com/kramber1024/url-shortener
- Size: 314 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# URL Shortener API
## Stack & Features
- 🌐 [**FastAPI**](https://fastapi.tiangolo.com/) for Python backend.
- 📋 [Pydantic](https://docs.pydantic.dev/), used for data validation and settings management.
- 💾 [PostgreSQL](https://www.postgresql.org/) as SQL Database.
- 🐋 [**Docker**](https://www.docker.com/) for development, testing and production.
- 🏭 CI/CD with [**GitHub Actions**](https://github.com/kramber1024/url-shortener-api/actions/).
- 🔑 [**JWT**](https://jwt.io/) based authentication.
- ✅ Tests with [**Pytest**](https://pytest.org/).
- 🔒 Secure password hashing.
- ✉️ Password recovery with email.
> [!WARNING]
> This repository is part of a larger project that consists of multiple repositories. Using this repository on its own is not recommended, as it may not function correctly without the other components of the project. For complete functionality and proper integration, please refer to the [kramber1024/url-shortener](https://github.com/kramber1024/url-shortener).
## Local launch
### Requirements
- 🐍 [**Python 3.12**](https://www.python.org/)
### Installation
Clone the repository:
```bash
git clone https://github.com/kramber1024/url-shortener-api.git
```
Navigate to the project directory:
```bash
cd url-shortener-api
```
Create a virtual environment:
```bash
python -m venv venv
```
Activate the virtual environment:
- On Linux and macOS:
```bash
source venv/bin/activate
```
- On Windows:
```bat
.\venv\Scripts\activate
```
Install [**Poetry**](https://python-poetry.org/) package manager:
```bash
pip install poetry
```
Install dependencies required to run the project:
```bash
poetry install --only main --no-root
```
Run the project:
```bash
python -m app.main
```
You can see the result by navigating to one of the following addresses:
- **http://127.0.0.1:26801/api/docs** - Swagger UI
- **http://127.0.0.1:26801/api/redoc** - ReDoc
> [!NOTE]
> Documentation for testing, running in Docker, and environment variables can be found in [**DEVELOPMENT.md**](./DEVELOPMENT.md).
## License
This project is licensed under the terms of the [**MIT license**](./LICENSE).