diff --git a/web/README.md b/web/README.md index da8d02a..d57d6be 100644 --- a/web/README.md +++ b/web/README.md @@ -1,38 +1,71 @@ -# Welcome to Remix! +
+
+
+
A self-hosted digital flight logbook
-```sh -npm run dev +## 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 +web frontend. + +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 + +- npm +- [tailfin-api](https://github.com/azpsen/tailfin-api) + +### Installation + +1. Clone the repo + +``` +$ git clone https://git.github.com/azpsen/tailfin-web.git +$ cd tailfin-web ``` -This starts your app in development mode, rebuilding assets on file changes. +3. Install NPM requirements -## Deployment - -First, build your app for production: - -```sh -npm run build +``` +$ npm install ``` -Then run the app in production mode: +5. Build and run the web app -```sh -npm start +``` +$ npm run build && npm run start ``` -Now you'll need to pick a host to deploy it to. +## Usage -### DIY +Once running, the web app can be accessed at `localhost:3000` -If you're familiar with deploying node applications, the built-in Remix app server is production-ready. +Currently, this only supports a local Tailfin API instance running at `localhost:8081`. This can be modified by manually editing `app/util/api.ts`. -Make sure to deploy the output of `remix build` +## Roadmap -- `build/` -- `public/build/` +- [x] Basic API sessions and data fetching +- [ ] Functionality for adding flights +- [ ] Dashboard with statistics +- [ ] Attach photos to log entries +- [ ] Admin dashboard to manage all users and server configuration +- [ ] Integrate database of airports and waypoints that can be queried to find nearest +- [ ] GPS track recording and map display