diff --git a/README.md b/README.md index f24a987..bdb61eb 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,41 @@ # OKDP.io -OKDP website, temporary made with Vite. +
+ OKDP Logo + +
+ +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +[![Website](https://img.shields.io/badge/website-okdp.io-informational)](https://okdp.io) + +
+ +## About the Site + +This repository contains the source of the **okdp.io** marketing website, a bilingual (FR/EN) static site showcasing the OKDP platform, its architecture, modules, and roadmap. ## Development ```bash # Install dependencies npm install -# Run the development server + +# Generate HTML from templates, then start the dev server npm run dev ``` + +`npm run dev` runs two steps in sequence: +1. `npm run generate`: compiles Handlebars templates with locale data from `src/locales` +2. `vite`: starts the dev server with hot reload + +## Build + +```bash +npm run build # generate + vite build -> outputs to dist/ +npm run preview # preview the production build locally +``` + +## Community + +- Organization: [TOSIT Association](https://tosit.fr) +- Communication: [Github discussion](https://github.com/orgs/OKDP/discussions)