History

Michael Zhang 08a19b6a94 init		2023-10-16 07:49:17 -04:00
..
public	init	2023-10-16 07:49:17 -04:00
src	init	2023-10-16 07:49:17 -04:00
.gitignore	init	2023-10-16 07:49:17 -04:00
bsconfig.json	init	2023-10-16 07:49:17 -04:00
index.html	init	2023-10-16 07:49:17 -04:00
package-lock.json	init	2023-10-16 07:49:17 -04:00
package.json	init	2023-10-16 07:49:17 -04:00
postcss.config.cjs	init	2023-10-16 07:49:17 -04:00
README.md	init	2023-10-16 07:49:17 -04:00
tailwind.config.cjs	init	2023-10-16 07:49:17 -04:00
vite.config.js	init	2023-10-16 07:49:17 -04:00

README.md

ReScript / Vite Starter Template

This is a Vite-based template with following setup:

ReScript 10.1 with @rescript/react and JSX 4 automatic mode
ES6 modules (ReScript code compiled to .bs.mjs files)
Vite 4 with React Plugin (Fast Refresh)
Tailwind 3

Development

Run ReScript in dev mode:

npm run res:dev

In another tab, run the Vite dev server:

npm run dev

Tips

Fast Refresh & ReScript

Make sure to create interface files (.resi) for each *.res file.

Fast Refresh requires you to only export React components, and it's easy to unintenionally export other values that will disable Fast Refresh (you will see a message in the browser console whenever this happens).

Why are the generated `.bs.mjs` files tracked in git?

In ReScript, it's a good habit to keep track of the actual JS output the compiler emits. It allows quick sanity checking if we made any changes that actually have an impact on the resulting JS code (especially when doing major compiler upgrades, it's a good way to verify if production code will behave the same way as before the upgrade).

This will also make it easier for your Non-ReScript coworkers to read and understand the changes in Github PRs, and call you out when you are writing inefficient code.