Feedback API

Simple API to manage post-event feedback built with elyisa, postgres and drizzle-orm.

Development Setup

Fork and clone the repository

• Fork the repository

git clone https://github.com/<username>/feedback-api

Note

This project uses the bun runtime, make sure to have it installed before continuing

Install the dependencies

bun install

Setup the environment variables

• Create a .env.local file in the root directory (see .env.example for an example)

Tip

If you don't have a postgres instance running, you can start the db service using docker compose

docker compose up -d db

Run the migrations

bun run db:migrate

Start the development server

bun run dev

Deployment

The repo provides start-service.sh to automate the process of installing docker and starting the service

chmod +x ./scripts/start-service.sh # make the script executable

./scripts/start-service.sh

Note

Alternatively if you have docker compose installed already, just start the services

docker compose up

Setting up nginx

chmod +x ./scripts/setup-nginx.sh

./scripts/setup-nginx.sh

Tech Stack

• Bun
• Elysia
• drizzle
• PostgreSQL
• TypeScript
• GitHub Actions
• Docker
• Docker Compose
• Nginx