diff --git a/frontend/README.md b/frontend/README.md index db0bd16..0cf3a93 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -1,18 +1,14 @@ -# terrains-connus +# Terrains Connus -This template should help get you started developing with Vue 3 in Vite. +Project for the hackathon données alimentaires. -## Recommended IDE Setup +## Dependencies -[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur). - -## Type Support for `.vue` Imports in TS - -TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types. - -## Customize configuration - -See [Vite Configuration Reference](https://vite.dev/config/). +You need to have [Bun](https://bun.sh/) installed to be able to run the project. +To install Bun: +```sh +curl -fsSL https://bun.sh/install | bash +``` ## Project Setup @@ -31,3 +27,9 @@ bun dev ```sh bun run build ``` + +## 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 `prod` 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.