add minimal readme

This commit is contained in:
lilly 2026-06-09 21:46:40 +02:00
commit c4785a3e55
Signed by: lilly
SSH key fingerprint: SHA256:y9T5GFw2A20WVklhetIxG1+kcg/Ce0shnQmbu1LQ37g

View file

@ -1,43 +1,24 @@
# Astro Starter Kit: Minimal
# Website zur Überwachungsfrei Kundgebung
## Developing Locally
Edit the main pages in [src/pages/](./src/pages/) and run the following commands in a separate terminal.
```sh
pnpm create astro@latest -- --template minimal
pnpm install
pnpm run dev
```
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
## Deploying
## 🚀 Project Structure
Inside of your Astro project, you'll see the following folders and files:
```text
/
├── public/
├── src/
│ └── pages/
│ └── index.astro
└── package.json
```sh
pnpm run build
rsync -rv --delete dist/ public-web-static.hosts.hamburg.ccc.de:uberwachungsfrei-kundgebung.hamburg.ccc.de/
```
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
Then on public-web-static
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
```sh
sudo rsync -rv --delete --chown=ueberwachungsfrei-deploy:ueberwachungsfrei-deploy ./uberwachungsfrei-kundgebung.hamburg.ccc.de/ /var/www/ueberwachungsfrei-kundgebung.hamburg.ccc.de/
```
Any static assets, like images, can be placed in the `public/` directory.
## 🧞 Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
| :------------------------ | :----------------------------------------------- |
| `pnpm install` | Installs dependencies |
| `pnpm dev` | Starts local dev server at `localhost:4321` |
| `pnpm build` | Build your production site to `./dist/` |
| `pnpm preview` | Preview your build locally, before deploying |
| `pnpm astro ...` | Run CLI commands like `astro add`, `astro check` |
| `pnpm astro -- --help` | Get help using the Astro CLI |
## 👀 Want to learn more?
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).