https://github.com/alex-schaaf/zest
zest is an open-source, self-hostable dashboard for your running data
https://github.com/alex-schaaf/zest
fitness nestjs postgresql prisma-orm reactjs running strava turborepo vitejs
Last synced: 4 months ago
JSON representation
zest is an open-source, self-hostable dashboard for your running data
- Host: GitHub
- URL: https://github.com/alex-schaaf/zest
- Owner: alex-schaaf
- License: mit
- Created: 2023-01-15T21:07:10.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-28T17:22:09.000Z (almost 2 years ago)
- Last Synced: 2024-08-28T19:09:21.265Z (almost 2 years ago)
- Topics: fitness, nestjs, postgresql, prisma-orm, reactjs, running, strava, turborepo, vitejs
- Language: TypeScript
- Homepage:
- Size: 2.53 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
zest
zest is an open-source, self-hostable dashboard for your running data.
## Description
`zest` integrates with services like [Strava](https://strava.com/), using their
API to download all available running activities and storing them locally in a
PostgreSQL database.
Integrations:
- [x] [Strava](https://strava.com/)
- [ ] [Garmin Connect](https://connect.garmin.com/)
- [ ] Upload `.FIT` file
## Getting started
Install dependencies by running `yarn` in the root folder.
### Project structure
Every folder in the `/apps`folder represents a `yarn`
[workspace](https://yarnpkg.com/features/workspaces).
- `apps/api` contains the Nest.js API
- `apps/web` contains the Vite.js React frontend
Running scripts for the individual workspaces can be done from the root project
folder using `yarn workspace run `. For example
running the apps individually in development mode:
### Development mode
```bash
# start both api and web in dev mode
turbo dev
```
- The API is available at `localhost:3000`, with the Swagger docs accessible at
`localhost:3000/docs`.
- The frontend is available at `localhost:5173`.
### Testing
#### API
Testing is done using the `jest` testing framework. Tests are stored `*.spec.ts`
files next to the code files they are testing.
```
yarn workspace api run test
```