From 3517f5362487fd4936409badb703d5772df83a89 Mon Sep 17 00:00:00 2001 From: Jalil Arfaoui <jalil@arfaoui.net> Date: Mon, 17 Mar 2025 23:40:37 +0100 Subject: [PATCH] README --- README.md | 84 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 44 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index ff19a3e..b7653c6 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,52 @@ -# Astro Starter Kit: Basics +# Rules as Code 2025 -```sh -npm create astro@latest -- --template basics +A presentation of the usage of Publicodes language in mon-entreprise.urssaf.fr for Rules as Code Europe event. + +## 📖 About + +This presentation explores modele-social implementation with Publicodes, focusing on how to transform legal and regulatory rules into machine-readable code. It covers implementation strategies, benefits, challenges, and real-world examples in action. + +## 🚀 Getting Started + +### Prerequisites + +- Node.js (v18 or later recommended) +- npm + +### Installation + +```bash +# Clone the repository +git clone forgejo@forge.tiqa.fr:betagouv/rules-as-code-2025.git +cd rules-as-code-2025 +npm install ``` -[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics) -[](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics) -[](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json) - -> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! - - - -## 🚀 Project Structure - -Inside of your Astro project, you'll see the following folders and files: - -```text -/ -├── public/ -│ └── favicon.svg -├── src/ -│ ├── layouts/ -│ │ └── Layout.astro -│ └── pages/ -│ └── index.astro -└── package.json -``` - -To learn more about the folder structure of an Astro project, refer to [our guide on project structure](https://docs.astro.build/en/basics/project-structure/). - ## 🧞 Commands -All commands are run from the root of the project, from a terminal: +| Command | Action | +| :-------------- | :------------------------------------------ | +| `npm run dev` | Start local dev server at `localhost:4321` | +| `npm run build` | Build the presentation for production | +| `npm run preview` | Preview the built presentation | -| Command | Action | -| :------------------------ | :----------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:4321` | -| `npm run build` | Build your production site to `./dist/` | -| `npm run preview` | Preview your build locally, before deploying | -| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | -| `npm run astro -- --help` | Get help using the Astro CLI | +## 🧰 Tech Stack -## 👀 Want to learn more? +- [Astro](https://astro.build/) - Web framework for content sites +- [Reveal.js](https://revealjs.com/) - HTML presentation framework -Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). +## 📋 Presentation Content + +The presentation covers: + +- Context and background of mon-entreprise project +- Examples of rules +- Technical implementation approaches +- Interactive documentation possibilities +- Live demonstrations +- Challenges and limitations +- Future perspectives + +## 👥 Team + +This presentation was created by mon-entreprise.urssaf.fr team.