Merge branch 'master' of https://github.com/azpsen/tailfin-web

web/README.md

@@ -1,38 +1,71 @@
-# Welcome to Remix!
+<p align="center">
+    <a href="" rel="nooperner">
+    <img width=200px height=200px src="public/logo.png" alt="Tailfin Logo"></a>
+</p>
 
-- [Remix Docs](https://remix.run/docs)
+<h3 align="center">Tailfin</h3>
 
-## Development
+---
 
-From your terminal:
+<p align="center">A self-hosted digital flight logbook</p>
 
-```sh
+## Table of Contents
-npm run dev
+
++ [About](#about)
++ [Getting Started](#getting_started)
++ [Configuration](#configuration)
++ [Usage](#usage)
++ [Roadmap](#roadmap)
+
+## About <a name="about"></a>
+
+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 <a name="getting_started"></a>
+
+### 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
+```
-
+$ npm install
-First, build your app for production:
-
-```sh
-npm run build
 ```
 
-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 <a name="usage"></a>
 
-### 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 <a name="roadmap"></a>
 
-- `build/`
+- [x] Basic API sessions and data fetching
-- `public/build/`
+- [ ] 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