From 6b8b2022ce9b4954b6913e083a156c9ace0dba22 Mon Sep 17 00:00:00 2001 From: Fishon Amos <43862685+fishonamos@users.noreply.github.com> Date: Wed, 15 May 2024 11:52:48 +0100 Subject: [PATCH] Update README.md --- README.md | 60 ------------------------------------------------------- 1 file changed, 60 deletions(-) diff --git a/README.md b/README.md index 087792c..7dd88b5 100644 --- a/README.md +++ b/README.md @@ -100,63 +100,3 @@ make install-deps # Testing make test # Runs all the tests make test-assets test-go # Run tests for the individual components - -# Building -make build # Builds all components -make build-tw # Builds the Tailwind CSS output file -make build-server # Builds the web server -make build-docker # Performs all builds inside Docker containers, creates a Docker image -make build-swagger # Generates swagger docs - -# Translating -make generate-messages # Detects all translatable strings and write them to translations/messages.yaml -make generate-translations # Populates the translation files per language - - -# Running it -make serve # Runs the compiled binary -make dev # Runs a wrapper that watches for changes, then rebuilds and restarts -make watch-tw # Runs the Tailwind CSS watcher (not useful unless you're debugging Tailwind CSS) - -# Cleanin' up -make clean # Removes build artifacts -``` - -## What is this, technically? - -A single binary that runs on any platform, with no dependencies. - -The binary contains all assets to serve a web interface, through which you can -upload your GPX files, visualize your tracks and see their statistics and -graphs. The web application is multi-user, with a simple registration and -authentication form, session cookies and JWT tokens). New accounts are inactive -by default. An admin user can activate (or edit, delete) accounts. The default -database storage is a single SQLite file. - -## What technologies are used - -- Go, with some notable libraries - - [gpxgo](github.com/tkrajina/gpxgo) - - [Echo](https://echo.labstack.com/) - - [Gorm](https://gorm.io) - - [Spreak](https://github.com/vorlif/spreak) -- HTML, CSS and JS - - [Tailwind CSS](https://tailwindcss.com/) - - [Font Awesome](https://fontawesome.com/) - - [FullCalendar](https://fullcalendar.io/) - - [Leaflet](https://leafletjs.com/) - - [sorttable](https://www.kryogenix.org/code/browser/sorttable/) - - [apexcharts](https://apexcharts.com/) -- Docker - -The application uses OpenStreetMap as its map provider and for geocoding a GPS -coordinate to a location. - -## Compatiblity - -This is a work in progress. If you find any problems, please let us know. The -application is tested with GPX files from these sources: - -- Garmin Connect (export to GPX) -- FitoTrack (automatic export to GPX) -- Workoutdoors (export to GPX) \ No newline at end of file