Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fishonamos authored May 15, 2024
1 parent 0f4bb1f commit 6b8b202
Showing 1 changed file with 0 additions and 60 deletions.
60 changes: 0 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit 6b8b202

Please sign in to comment.