59 lines
1.3 KiB
Markdown
59 lines
1.3 KiB
Markdown
# 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
|
|
|
|
Please use Jetbrains WebStorm and install the latest version of [Bun](https://bun.sh/).
|
|
|
|
### Dev environment
|
|
|
|
First copy the example `.env` file and change the settings to your liking:
|
|
|
|
```shell
|
|
cp .env.example .env
|
|
```
|
|
|
|
Now start the necessary services using `docker-compose -f docker-compose.yml -f docker-compose.dev.yml up -d` or
|
|
`bun run dev:up`.
|
|
|
|
Wait for a few seconds and then migrate the database:
|
|
|
|
```shell
|
|
bun install
|
|
bunx prisma migrate deploy
|
|
```
|
|
|
|
Now you can start the web dev server:
|
|
|
|
```shell
|
|
bun run dev
|
|
```
|
|
|
|
The development server listens on `http://localhost:3080`:
|
|
|
|
### Production
|
|
|
|
Build the application for production:
|
|
|
|
```bash
|
|
# bun
|
|
bun run build -- --preset bun
|
|
```
|
|
|
|
Locally preview production build:
|
|
|
|
```bash
|
|
# bun
|
|
bun run preview
|
|
```
|
|
|
|
Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
|