Docs

README.md

@@ -1,73 +1,56 @@
-# Nuxt Minimal Starter
+# PicHunt
+
+> Create Quests and let others solve them by taking pictures!
 
 Look at the [Nuxt documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
 
+## Infra
+
+This project depends on a PostgreSQL database and a S3-compliant storage bucket, that has public read enabled. Redis is
+not (yet) used, but may be used in the future for caching and/or synchronizing event streams for notifications.
+
 ## Setup
 
-Make sure to install dependencies:
+Please use Jetbrains WebStorm and install the latest version of [Bun](https://bun.sh/).
 
-```bash
-# npm
-npm install
+### Dev environment
 
-# pnpm
-pnpm install
+First copy the example `.env` file and change the settings to your liking:
 
-# yarn
-yarn install
-
-# bun
-bun install
+```shell
+cp .env.example .env
 ```
 
-## Development Server
+Now start the necessary services using `docker-compose -f docker-compose.yml -f docker-compose.dev.yml up -d` or
+`bun run dev:up`.
 
-Start the development server on `http://localhost:3000`:
+Wait for a few seconds and then migrate the database:
 
-```bash
-# npm
-npm run dev
+```shell
+bun install
+bunx prisma migrate deploy
+```
 
-# pnpm
-pnpm dev
+Now you can start the web dev server:
 
-# yarn
-yarn dev
-
-# bun
+```shell
 bun run dev
 ```
 
-## Production
+The development server listens on `http://localhost:3080`:
+
+### Production
 
 Build the application for production:
 
 ```bash
-# npm
-npm run build
-
-# pnpm
-pnpm build
-
-# yarn
-yarn build
-
 # bun
-bun run build
+bun run build -- --preset bun
 ```
 
 Locally preview production build:
 
 ```bash
-# npm
-npm run preview
-
-# pnpm
-pnpm preview
-
-# yarn
-yarn preview
-
 # bun
 bun run preview
 ```