Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: 20 days ago
JSON representation

🏋️ Full-fledged backend utilizing Storona for routing.

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)

  - [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

- [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.



### 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

```