Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edance/openpace
🏃 Track Runs and Workouts
https://github.com/edance/openpace
elixir phoenix runner running
Last synced: 3 months ago
JSON representation
🏃 Track Runs and Workouts
- Host: GitHub
- URL: https://github.com/edance/openpace
- Owner: edance
- License: gpl-3.0
- Created: 2017-10-28T00:27:29.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2023-12-14T03:39:26.000Z (7 months ago)
- Last Synced: 2024-01-21T18:46:45.987Z (6 months ago)
- Topics: elixir, phoenix, runner, running
- Language: Elixir
- Homepage: https://www.openpace.co
- Size: 7.89 MB
- Stars: 14
- Watchers: 1
- Forks: 2
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Lists
- awesome-stars - edance/openpace - 🏃 Track Runs and Workouts (Elixir)
README
[](http://spacemacs.org)
[](https://github.com/edance/openpace/actions/workflows/ci.yml)
[](https://coveralls.io/github/edance/openpace?branch=main)
[](https://github.com/edance/openpace/blob/main/LICENSE.md)
OpenPace is an open-source, web application that helps runners run their fastest marathon built with [Phoenix LiveView](https://github.com/phoenixframework/phoenix_live_view). It features tools to hit new personal bests, analyze your training program, and take a deep dive into your race performance.
From a developer standpoint, it features:
* Sync's all fitness data from [Strava](https://github.com/slashdotdash/strava) including activities, GPS, heart rate, pace information.
* Dashboard based off of the [Argon Dashboard by Creative Tim](https://www.creative-tim.com/product/argon-dashboard) using [Bootstrap 4](https://getbootstrap.com)
* Canvas charts provided by [Chart.js](https://chartjs.org) using [Phoenix LiveView hooks](https://hexdocs.pm/phoenix_live_view/js-interop.html#client-hooks-via-phx-hook)
* Maps using [Mapbox GL](https://mapbox.com)
* Payment processing with Stripe using the [Stripity Stripe](https://github.com/beam-community/stripity_stripe)
I'm actively working on Openpace and can use any help I can get. Feel free to create an issue or open a pull request.
## Documentation
Documentation is hosted using ex_doc. And you can view the documentation [here](https://www.openpace.co/docs).
## Development
We provide several methods for running Openpace, pick the one that best fits your use case.
### Docker
Running Openpace using Docker is a great option for local usage in case you don't have Elixir installed.
```shell
git clone https://github.com/edance/openpace.git
cd openpace
# Copy the example env to your own file and edit it
cp .env.example .env
# Running with the default configuration
docker compose up -d
# Visit localhost:4000
open http://localhost:4000
```
### Direct installation with Elixir
You'll need to install Elixir v1.13 or later. I recommend installing using [asdf](https://github.com/asdf-vm/asdf) with `asdf install elixir`.
```shell
git clone https://github.com/edance/openpace.git
cd openpace
# Copy the example env to your own file and edit it
cp .env.example .env
# Use this command to export the variables into your system
export $(cat .env | grep -v ^# | xargs)
# Get dependencies, create and seed database, and install js deps
mix setup
# Start Phoenix Server
iex -S mix phx.server
# Visit localhost:4000
open http://localhost:4000
```
You will then be able to sign in with `[email protected]` and the password `password`.
### Import Strava Activities
#### Option 1 (detailed activities with trackpoints and laps)
* Create an account with an email (or sign in with `[email protected]` and password `psasword`)
* Visit `/dashboard/strava-bulk-upload` and follow the instructions on the page
You will be required to download your data from Strava and upload the zip file to this page.
When completed, you'll have all of your activities as well as trackpoints and laps.
#### Option 2 (summary activities without trackpoints and laps)
Add the environment variables below and sign in with Strava.
When fetching many activities from Strava, you will receive a list `SummaryActivity` which does not contain trackpoints or laps.
### Environment Variables
To run locally, you'll need to set up a [strava api account](https://www.strava.com/settings/api). And set the following environment variables.
* STRAVA_CLIENT_ID
* STRAVA_CLIENT_SECRET
* STRAVA_WEBHOOK_TOKEN
There are additional environment variables in `.env.example`.
### Feedback
Please create a github issue with any ideas, feedback, or suggestions, etc. Pull requests are welcome.
## Why is it named squeeze?
The project was originally under the domain [squeeze.run](https://squeeze.run) with the goal of taking all your running data and "squeezing" it into summaries and graphs.
## Deployment on Fly
This project is run on fly.io. You can run your own with `fly deploy`.
Fly deploy does not include `mix` so one-off tasks have to be run using a command like:
```shell
fly ssh console -C "/app/bin/squeeze eval Squeeze.TaskModule.method"
```
See `Squeeze.Release.migrate` for an example.
You can also open remote iex with:
```shell
fly ssh console -C "/app/bin/squeeze remote"
```