Skip to content

doc: add description how to run in dev mode #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc: add description how to run in dev mode #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
```