# fastapi-url-shortener

**Repository Path**: open_source_reference/fastapi-url-shortener

## Basic Information

- **Project Name**: fastapi-url-shortener
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-07-30
- **Last Updated**: 2024-11-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# FastAPI URL Shortener

## Install the Project

1. Create a Python virtual environment

```sh
$ python -m venv venv
$ source venv/bin/activate
(venv) $
```

2. Install the requirements

```
(venv) $ python -m pip install -r requirements.txt
```

## Run the Project

You can run the project with this command in your terminal:

```sh
(venv) $ uvicorn shortener_app.main:app --reload
```

Your server will reload automacially when you change a file.

## Verify Your Environment Variables

The project provides default environment settings in [`shortener_app/config.py`](shortener_app/config.py).
While you can use the default settings, [it's recommended](https://12factor.net/config) to create a `.env` file to store your settings outside of your production code. E.g.:

```config
# .env
ENV_NAME="Development"
BASE_URL="http://url.shortener"
DB_URL="sqlite:///./test_database.db"
```

With an `.env` file that contains the `ENV_NAME` variable with the value `"Development"` you can verify if your external `.env` file loads correctly:

```pycon
>>> from shortener_app.config import get_settings
>>> get_settings().env_name
... loading Settings
'Development'
```

To get an overview of the environment variables you can set, check the [`shortener_app/config.py`](shortener_app/config.py) file.

> ☝️ **Note:** You should never add the `.env` file to your version control system. 

## Visit the Documentation

When the project is running you can visit the documentation in your browser:

- http://127.0.0.1:8000/docs
- http://127.0.0.1:8000/redoc

## About the Author

Philipp Acsany - Email: philipp@realpython.com

## License

Distributed under the MIT license. See `LICENSE` in the root directory of this `materials` repo for more information.