From 70d3162146644c402dde3b308f99a1d857681f8c Mon Sep 17 00:00:00 2001 From: RcleydsonR Date: Fri, 28 Oct 2022 17:04:46 -0300 Subject: [PATCH] update README to include docker-compose run --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 998097c..909dd1d 100644 --- a/README.md +++ b/README.md @@ -21,26 +21,37 @@ If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has a See [Vite Configuration Reference](https://vitejs.dev/config/). -## Project Setup +## Project Setup (with yarn) ```sh -npm install +yarn ``` ### Compile and Hot-Reload for Development ```sh -npm run dev +yarn lint ``` ### Type-Check, Compile and Minify for Production ```sh -npm run build +yarn build ``` ### Lint with [ESLint](https://eslint.org/) ```sh -npm run lint +yarn lint +``` +## Project Setup (with docker-compose) +### Dependencies + +1. Install [Docker](https://docs.docker.com/install/linux/docker-ce/ubuntu/); +2. Install [Docker Compose](https://docs.docker.com/compose/install/). + +### In the main project folder, build and start the application with the command: + +```sh +docker-compose up ```