Kenzo
5922d5d274
This commit updates multiple dependencies within `package-lock.json`, including upgrades for Astro, @astrojs packages, and various Sharp components. Additionally, it introduces new optional dependencies and enforces compatibility with Node 18 and higher in certain components.
56 lines
2.0 KiB
Markdown
56 lines
2.0 KiB
Markdown
# Gallus Pub Website
|
||
|
||
This is the Gallus Pub website built with Astro. It includes an admin area at `/admin` for editing content (events, gallery, texts). Changes are committed back to the Git repository via the Gitea API which triggers your Woodpecker + Fly.io deployment pipeline.
|
||
|
||
## Local development
|
||
|
||
To run the site locally with OAuth login (Gitea):
|
||
|
||
1. Copy the example env file and fill values:
|
||
```bash
|
||
cp .env.example .env.local
|
||
```
|
||
- Create a Gitea OAuth application with Redirect URI: `http://localhost:4321/api/auth/callback`.
|
||
- Set `OAUTH_CLIENT_ID` and `OAUTH_CLIENT_SECRET` from Gitea.
|
||
- Set `GITEA_OWNER`, `GITEA_REPO`, and a `GITEA_TOKEN` (PAT) with write access to the repo.
|
||
- Generate random secrets for sessions/CSRF (e.g. `openssl rand -hex 32`).
|
||
|
||
2. Install dependencies:
|
||
```bash
|
||
npm install
|
||
```
|
||
|
||
3. Start dev server using your local env file:
|
||
```bash
|
||
npm run dev:local
|
||
```
|
||
The site runs at http://localhost:4321. Visit http://localhost:4321/admin to log in via Gitea OAuth.
|
||
|
||
Notes:
|
||
- If OAuth variables are missing or malformed, the auth endpoints return a clear 500 with guidance instead of crashing.
|
||
- Production secrets are configured on Fly.io; `.env.local` is ignored by Git.
|
||
|
||
## Project structure
|
||
|
||
```
|
||
/
|
||
├── public/ # static assets
|
||
├── src/
|
||
│ ├── content/ # editable JSON content (events, gallery)
|
||
│ ├── pages/ # Astro pages, includes /admin and API routes
|
||
│ ├── components/ # UI components
|
||
│ └── utils/ # session helpers
|
||
├── .env.example # template for local env
|
||
├── fly.toml # Fly.io config
|
||
├── Dockerfile
|
||
└── package.json
|
||
```
|
||
|
||
## Commands
|
||
|
||
- `npm install` – install deps
|
||
- `npm run dev` – dev server without loading .env.local (expects env to be present in the shell)
|
||
- `npm run dev:local` – dev server loading `.env.local` via dotenv-cli
|
||
- `npm run build` – production build (SSR via @astrojs/node)
|
||
- `npm run preview` – preview the production build
|