Migrated to Astro

README.md

@@ -1,3 +1,40 @@
-# Oblic Parallels website
+# Oblic Parallels Home Website
 
-Pure static HTML/CSS website for https://oblic-parallels.fr
+## About
+
+Contains the source code of the Home OP website.
+Now uses Astro instead of the old static website !
+
+## Structure
+
+### Project
+
+- `src/*` - Source code (components, pages, styles, images, etc.)
+- `public/*` - Non-code, unprocessed assets (fonts, icons, etc.)
+- `package.json` - Project manifest
+- `astro.config.mjs` - Astro configuration file
+- `tsconfig.json` - TypeScript configuration file
+
+### src/
+
+- `assets/`
+- `components/`
+- `layouts/`
+- `pages/`
+- `data/` - Contains the configs to generate the website, each as a JSON file (contains cards, site name, etc.)
+- `styles` - default CSS style sheets and custom themes
+
+## Build
+
+This project is meant to be used with `pnpm`, but you can use whatever package manager you want (at your own risk).
+
+### Commands
+
+| 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                     |