From 5d1d239e9e3b8213751ba8097b345084c8d0c2b4 Mon Sep 17 00:00:00 2001 From: Enieber Cunha <7907068+enieber@users.noreply.github.com> Date: Wed, 6 Mar 2024 15:03:52 -0300 Subject: [PATCH] doc: add description how to run in dev mode --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2018e30..5d60f8e 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,29 @@ # Vite ReScript Template -## Getting started +## Use this template + +click on "Use this template" or use npx :) ```shell +# create with clone project npx degit rescriptbr/vite-rescript-starter my-app +# enter in app folder cd my-app +# install dependency npm install ``` -or simply click on "Use this template" :) +### Development + +To development is require compile rescript + run vite: + +```shell +# compile rescript with watch mode +npm run res:dev + +# open new tab +# run vite dev +npm run dev +```