From c4785a3e554092c7ea318772378e2ffd6f186e2f Mon Sep 17 00:00:00 2001 From: lilly Date: Tue, 9 Jun 2026 21:46:40 +0200 Subject: [PATCH] add minimal readme --- README.md | 49 +++++++++++++++---------------------------------- 1 file changed, 15 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 817dd80..f66efc5 100644 --- a/README.md +++ b/README.md @@ -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).