A self-hosted digital flight logbook
## Table of Contents + [About](#about) + [Getting Started](#getting_started) + [Configuration](#configuration) + [Usage](#usage) + [Roadmap](#roadmap) ## About Tailfin is a digital flight logbook designed to be hosted on a personal server, computer, or cloud solution. This is the API segment and can be run independently. It is meant to be a base for future applications, both web and mobile. I created this because I was disappointed with the options available for digital logbooks. The one provided by ForeFlight is likely most commonly used, but my proclivity towards self-hosting drove me to seek out another solution. Since I could not find any ready-made self-hosted logbooks, I decided to make my own. ## Getting Started ### Prerequisites - python 3.11+ - mongodb 7.0.4 ### Installation 1. Clone the repo ``` $ git clone https://git.github.com/azpsen/tailfin-api.git $ cd tailfin-api ``` 2. (Optional) Create and activate virtual environment ``` $ python -m venv tailfin-env $ source tailfin-env/bin/activate ``` 3. Install python requirements ``` $ pip install -r requirements.txt ``` 4. Configure the database connection The default configuration assumes a running instance of MongoDB on `localhost:27017`, secured with username and password `tailfin-api` and `tailfin-api-password`. This can (and should!) be changed by modifying `.env`, as detailed in [Configuration](#configuration). Note that the MongoDB instance must be set up with proper authentication before starting the server. I hope to eventually release a docker image that will simplify this whole process. 5. Start the server ``` $ python app.py ``` ## Configuration To configure Tailfin, modify the `.env` file. Some of these options should be changed before running the server. All available options are detailed below: `DB_URI`: Address of MongoDB instance. Default: `localhost`