diff --git a/README.md b/README.md index 25b5821..08b7896 100644 --- a/README.md +++ b/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 ``` diff --git a/TODO.md b/TODO.md index 95b50e3..4d29c06 100644 --- a/TODO.md +++ b/TODO.md @@ -1,13 +1,14 @@ - **Required** - **Auth** - - [ ] Flawless! Login (Email+Pw ohne bestätigung?) - - [ ] Default random name + - [x] Flawless! Login (Email+Pw ohne bestätigung?) + - [x] Default random name - [ ] Change display name - **Hunt Admin** - [ ] Start/Stop - [ ] Add Reviews/Score - [ ] View best Answers and Pictures - [ ] All/Best Images gallery + - [ ] Manage teams (remove, kick, add) - **Hunt User** - [x] Create Team - [x] Invite Members @@ -38,8 +39,11 @@ - [ ] i18n - [ ] Process image uploads (resize, remove EXIF, etc.) - [ ] Mark image as private + - [ ] Support chat + - [ ] Leave/Remove team + - [ ] Copy team from different hunt - **General** - - [ ] Pretty slugified urls + - [x] Pretty slugified urls - [ ] SEO, Meta, Preview - [ ] Deployment `.on.hs-bremen.de`?? diff --git a/package.json b/package.json index ba5adaf..72006f8 100644 --- a/package.json +++ b/package.json @@ -9,7 +9,9 @@ "preview": "nuxt preview --host", "postinstall": "nuxt prepare", "format": "prettier --write .", - "check": "prettier --check ." + "check": "prettier --check .", + "dev:up": "docker-compose -f docker-compose.yml -f docker-compose.dev.yml up -d", + "dev:down": "docker-compose -f docker-compose.yml -f docker-compose.dev.yml down" }, "dependencies": { "@nuxtjs/i18n": "^10.0.3",