Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/domin-mnd/gym-backend
🏋️ Full-fledged backend utilizing Storona for routing.
https://github.com/domin-mnd/gym-backend
bun express kysely nodejs postgresql storona
Last synced: 15 days ago
JSON representation
🏋️ Full-fledged backend utilizing Storona for routing.
- Host: GitHub
- URL: https://github.com/domin-mnd/gym-backend
- Owner: domin-mnd
- Created: 2024-10-12T10:22:04.000Z (2 months ago)
- Default Branch: master
- Last Pushed: 2024-11-16T09:17:15.000Z (about 1 month ago)
- Last Synced: 2024-11-16T10:17:21.069Z (about 1 month ago)
- Topics: bun, express, kysely, nodejs, postgresql, storona
- Language: TypeScript
- Homepage: https://bump.sh/gym/doc/api
- Size: 290 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
> [!CAUTION]
> This API is not intended for public use. It can serve as an example usage of [storona](https://storona.domin.pro) in production.
# Contents
- [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Bun](#bun)
- [Node](#node)
- [Database](#database)
- [Auth](#auth)
- [Documentation](#documentation)
- [S3](#s3)
- [ERD](#erd)
- [Getting started](#getting-started)
- [Bun](#bun-1)
- [Node](#node-1)
# Introduction
This is a monolithic modern backend API that implements CRUD operations for a made up "Gym" project.
This API was designed as a smaller but full-fledged barebones express project without the use of any meta framework for extra abstraction. Instead it implements own architecture I'm fond of. Simplicity and flexibility are key to the project.
- [x] 📚 OpenAPI Specification
- [x] 📝 TSDoc Coverage
- [x] 🗂️ Database Repositories
- [x] 📖 ER Diagram
- [ ] 🖼️ AWS S3 Support
- [ ] 📧 SMTP Support
- [x] 📜 RFC 9110 Compliance
- [x] 🪖 Bulletproof
- [x] 🔍 Linting
- [x] ⚡ Bun Integration
- [x] 🪢 Backwards Node.js Compatibility
- [ ] 🚀 CI/CD
- [ ] 🧪 Complete Test Coverage
```mermaid
erDiagram
bank_card {
integer bank_card_id PK
character_varying card_number
character_varying cardholder_name
integer client_id FK
character_varying cvv
date expires_at
}
client {
integer client_id PK
timestamp_without_time_zone created_at
character_varying email_address UK
character_varying first_name
character_varying last_name
character_varying password_hash
character_varying patronymic
character_varying phone_number
character_varying profile_picture_url
}
employee {
integer client_id FK
integer employee_id PK
employee_type employee_type
timestamp_without_time_zone left_at
}
gym {
character_varying building
character_varying city
text description
integer gym_id PK
character_varying street
}
membership {
integer client_id FK
timestamp_without_time_zone created_at
timestamp_without_time_zone expires_at
timestamp_without_time_zone freezed_at
level_type level_type
integer membership_id PK
}
membership_payment_history {
integer client_id FK
timestamp_without_time_zone created_at
integer membership_id FK
integer membership_payment_history_id PK
integer payment_history_id FK
}
payment_history {
integer bank_card_id FK
integer client_id FK
timestamp_without_time_zone created_at
integer payment_history_id PK
timestamp_without_time_zone processed_at
boolean revoked
integer value
}
session {
integer client_id FK
timestamp_without_time_zone created_at
timestamp_without_time_zone expires_at
text jwt UK
boolean revoked
integer session_id PK
}
trainer_appointment {
timestamp_without_time_zone appointed_at
integer client_id FK
timestamp_without_time_zone created_at
integer employee_id FK
timestamp_without_time_zone ends_at
integer gym_id FK
integer payment_history_id FK
boolean revoked
integer trainer_appointment_id PK
}
visit_history {
integer client_id FK
timestamp_without_time_zone entered_at
integer gym_id FK
timestamp_without_time_zone left_at
integer visit_history_id PK
}
bank_card }o--|| client : "client_id"
payment_history }o--|| bank_card : "bank_card_id"
employee }o--|| client : "client_id"
membership }o--|| client : "client_id"
membership_payment_history }o--|| client : "client_id"
payment_history }o--|| client : "client_id"
session }o--|| client : "client_id"
trainer_appointment }o--|| client : "client_id"
visit_history }o--|| client : "client_id"
trainer_appointment }o--|| employee : "employee_id"
trainer_appointment }o--|| gym : "gym_id"
visit_history }o--|| gym : "gym_id"
membership_payment_history }o--|| membership : "membership_id"
membership_payment_history }o--|| payment_history : "payment_history_id"
trainer_appointment }o--|| payment_history : "payment_history_id"
```
> [!TIP]
> For OpenAPI documentation, head to /docs page of deployed API instance whether it is localhost or production one.
# Prerequisites
Current prerequisite scripts are only suitable if you run x86-64 linux machine. For other platforms, refer to corresponding tech docs for installing prerequisites.
Either use [bun](https://bun.sh/) **OR** [node](https://nodejs.org/) to run this API, preferably `bun` as it is much faster, however both are supported.
### Bun
To install bun, use following curl:
```bash
$ curl -fsSL https://bun.sh/install | bash
```
### Node
To install node, use following script used to install fnm for managing multiple node versions:
```bash
$ curl -fsSL https://fnm.vercel.app/install | bash
$ source ~/.bashrc
$ fnm use --install-if-missing 20
```
### Database
Project uses PostgreSQL database along with [Kysely](https://kysely.dev/) query builder.
To work with test database, you need to have `psql` preinstalled on your machine:
```bash
$ apt install postgresql
```
Along with that fill in `DATABASE_URL` environment variable.
### Auth
Authentication requires no additional setup, just the `SALT` environment variable.
### Documentation
In order to correctly setup OpenAPI Documentation, please fill `OPENAPI_BASE_PATH` and `OPENAPI_HOST` environment variables as stated [here](https://swagger.io/docs/specification/v2_0/api-host-and-base-path/).
If you're willing to deploy your API to a [Bump.sh](https://bump.sh/) then you need to provide `BUMP_TOKEN` actions' environment variable for CI.
### S3
To use S3, you need to provide `S3_ENDPOINT`, `S3_PORT`, `S3_ACCESS_KEY` & `S3_SECRET_KEY` environment variables.
Project uses [MinIO](https://min.io/) as a local S3 provider. To run a local instance, use following script:
```bash
$ wget https://dl.min.io/server/minio/release/linux-amd64/minio
$ chmod +x minio
$ ./minio server /data
```
### ERD
If you want to generate ERD diagram, you need to install [mermerd](https://github.com/KarnerTh/mermerd) to pull database schema from an already migrated database.
For that, install Golang and run `go install github.com/KarnerTh/mermerd@latest`:
```bash
$ wget https://go.dev/dl/go1.23.2.linux-amd64.tar.gz
$ tar -C /usr/local -xzf go1.23.2.linux-amd64.tar.gz
$ export PATH=$PATH:/usr/local/go/bin
$ rm -f go1.23.2.linux-amd64.tar.gz
$ go install github.com/KarnerTh/mermerd@latest
```
Now you can run `bun erd:types` to pull changes to `public/erd.mmd` path. For that you only need to type connection string prompted by mermerd.
To export to graphic format, run `bun erd:up`.
# Getting started
For node and bun runtimes, you can use following commands to install dependencies and start the API:
### Bun
```bash
$ bun i
$ bun start
```
### Node
```bash
$ npm i -g pnpm
$ pnpm i
$ pnpm start:node
```