Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bahattincinic/fitwave
Virtualize Your Strava Workouts
https://github.com/bahattincinic/fitwave
analytics echo-framework golang strava vuejs
Last synced: about 1 month ago
JSON representation
Virtualize Your Strava Workouts
- Host: GitHub
- URL: https://github.com/bahattincinic/fitwave
- Owner: bahattincinic
- License: mit
- Created: 2024-05-17T10:10:08.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-06-10T09:00:47.000Z (7 months ago)
- Last Synced: 2024-07-09T08:42:54.446Z (6 months ago)
- Topics: analytics, echo-framework, golang, strava, vuejs
- Language: Go
- Homepage:
- Size: 321 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FitWave
FitWave is a tool that lets you fetch your Strava data,
create custom dashboards using SQL, and view your workouts
with tables and charts. It helps you understand your training
better and make informed decisions about your fitness.
## Features
- **Data Integration:** Connect with your Strava account and get your workout data.
- **Custom Dashboards:** Use SQL to create dashboards that show the information you want.
- **Visualization Tools:** See your workout data in tables and charts.
- **User-Friendly Interface:** Easy to use and navigate.
- **Real-Time Updates:** Keep your dashboards updated with the latest data from Strava.
## Demo
To see FitWave in action, watch the demo on YouTube:
[](https://www.youtube.com/watch?v=Y7Hl4OOkgB4)
## Install the Project
There are a few options to install the project:
- [Download a release binary](#release-binaries)
- [Download a docker image](#docker-image)
- [Build a binary from source](#building-from-source)
### Release binaries
You can download the release binary for your system from the [releases page](https://github.com/bahattincinic/fitwave/releases).
### Docker image
To pull the [Docker image](https://hub.docker.com/r/bahattincinic/fitwave):
```bash
# Pull the latest image
docker pull bahattincinic/fitwave
# Or specify the image by tag
docker pull bahattincinic/fitwave[:tag]
```
### Building from source
**1. Clone the Repository**
```
git clone [email protected]:bahattincinic/fitwave.git
cd fitwave
```
**2. Build Backend**
```
make
```
**2. Build Frontend**
```
cd ui
npm install
```
#### Running the Application
**1. Run Backend**
Run project with the following command;
./fitwave
If you need to override the configuration, create a `.env` file.
**2. Run Frontend (`different terminal tab`)**
cd ui
npm run serve
## Environment Variables
| Field Name | Type | Default | Options/Examples |
|-----------------------|---------|---------------------|--------------------------------------------------------------------------------------------|
| ENV | string | local | - local
- production |
| LOG_LEVEL | string | debug | - debug
- info
- warn
- error
- panic
- fatal |
| LOG_OUTPUT | string | stdout | - stdout
- /foo/bar/fitwave.log |
| DATABASE_DSN | string | fitWave.db | - fitWave.db
- host=localhost user=postgres password=postgres dbname=fitwave port=5432 |
| DATABASE_TYPE | string | sqlite | - mysql
- postgresql
- sqlite |
| DATABASE_AUTO_MIGRATE | boolean | true | - true
- false |
| API_PORT | integer | 9000 | |
| API_SECRET_KEY | string | PBU_gha4zfk!rwj8axv | |
| API_TOKEN_EXPIRY_HOUR | int | 24 | |
## Production Build
Build Frontend
```
make build-frontend
```
Build Backend
```
make GCFLAGS="-tags=prod"
```
## Swagger API Documentation
To view the API Swagger documentation, please visit the following link:
[http://localhost:9000/api/docs/](http://localhost:9000/api/docs/)
Updating Swagger
make swaggen
## How to Deploy the Project to Render.com (Free)
### Create a PostgreSQL Database
1. Go to the [Render Dashboard](https://dashboard.render.com/new/database).
2. Follow the instructions to create a new PostgreSQL database.
### Deploying the Web Service
1. Go to the [Render Dashboard](https://dashboard.render.com/create?type=web).
2. Select "Deploy an existing image from a registry".
3. Enter the Docker image URL: [bahattincinic/fitwave](https://hub.docker.com/r/bahattincinic/fitwave).
### Add Environment Variables
Add the following environment variables to your web service:
```
DATABASE_TYPE=postgresql
DATABASE_DSN=host= user= password= dbname= port=5432
API_SECRET_KEY=
```
### Configure Health Check Path
In the Advanced section, set `/api/status` as the Health Check Path.
This configuration will ensure that your service is correctly monitored and maintained by Render.com.