diff --git a/README.md b/README.md index 25b58212c98dffd7229bbb5856f881efb3347868..e7087245d63053980c0419e3393d57092c3afd00 100644 --- a/README.md +++ b/README.md @@ -1,75 +1,41 @@ -# Nuxt Minimal Starter +# Archi Front -Look at the [Nuxt documentation](https://nuxt.com/docs/getting-started/introduction) to learn more. +Front-end part for the Archi project. -## Setup +## Installation -Make sure to install dependencies: +First, download this repository and unzip it to the folder of your choice. -```bash -# npm -npm install +If you have Git client, you can also use the following command: -# pnpm -pnpm install - -# yarn -yarn install - -# bun -bun install +```bash +git clone https://gitlab.imt-atlantique.fr/FIL-A3-2024/ue-proj/archi-front.git ``` -## Development Server +You will have to download Node [here](https://nodejs.org/en/download) and install it on your computer. + +## Setup -Start the development server on `http://localhost:3000`: +Make sure to install dependencies. Open the console (cmd) in the directory and type : ```bash # npm -npm run dev - -# pnpm -pnpm dev - -# yarn -yarn dev - -# bun -bun run dev +npm install ``` -## Production +## Development Server -Build the application for production: +Start the development server on `http://localhost:3000`. Open the console (cmd) in the directory and type : ```bash # npm -npm run build - -# pnpm -pnpm build - -# yarn -yarn build - -# bun -bun run build +npm run dev ``` -Locally preview production build: - -```bash -# npm -npm run preview - -# pnpm -pnpm preview +## Authors -# yarn -yarn preview +Renaud Birk and Anas Yakoubov -# bun -bun run preview -``` +## License -Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information. +This project is licensed under GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007.