From 5c6d322ba9a69e07e9ab4c6d08926ac72c4b037d Mon Sep 17 00:00:00 2001 From: Adrien Carpentier Date: Tue, 3 Dec 2024 16:48:45 +0100 Subject: [PATCH] docs: update README --- frontend/README.md => README.md | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) rename frontend/README.md => README.md (59%) diff --git a/frontend/README.md b/README.md similarity index 59% rename from frontend/README.md rename to README.md index 4659f64..5d210ee 100644 --- a/frontend/README.md +++ b/README.md @@ -2,20 +2,24 @@ Project for the hackathon "données alimentaires" on 2024 December 2nd/3rd. -## Description +"Terrains Connus" permet d'obtenir une vue d’ensemble des terres vendues, classées par typologie, et accédez rapidement aux détails spécifiques de chaque transaction, incluant son prix et sa classification. -Obtenez une vue d’ensemble des terres vendues, classées par typologie, et accédez rapidement aux détails spécifiques de chaque transaction, incluant son prix et sa classification. +## Frontend -## Deployment +```sh +cd frontend +``` + +### Deployment This project is automatically deployed to [https://opendatateam.github.io/terrains-connus/](https://opendatateam.github.io/terrains-connus/) whenever changes are pushed to the `main` branch. You can check the status of the deployment by visiting the [GitHub Actions page](https://github.com/opendatateam/terrains-connus/actions) for this repository. -## Run locally +### Run locally -### Dependencies +#### Dependencies You need to have [Bun](https://bun.sh/) installed to be able to run the project. To install Bun: @@ -23,20 +27,26 @@ To install Bun: curl -fsSL https://bun.sh/install | bash ``` -### Project Setup +#### Project Setup ```sh bun install ``` -### Compile and Hot-Reload for Development +#### Compile and Hot-Reload for Development ```sh bun dev ``` -### Type-Check, Compile and Minify for Production +#### Compile for Production ```sh bun run build ``` + +### Lint and format code + +```sh +biome check --write src/. +```