This is a NextJS based template with following setup:
- Full Tailwind v2 config & basic css scaffold (+ production setup w/ purge-css & cssnano)
- ReScript + React
- Some ReScript Bindings for Next to get you started
- Preconfigured Dependencies:
@rescript/react
Run ReScript in dev mode:
npm run res:start
In another tab, run the Next dev server:
npm run dev
Build CSS seperately via postcss (useful for debugging)
# Devmode
npx postcss styles/main.css -o test.css
# Production
NODE_ENV=production npx postcss styles/main.css -o test.css
# Make sure to uncomment the `target` attribute in `now.json` first, before you run this:
npm run build
PORT=3001 npm start
We ship some general bindings for NextJS, but we try to keep them simple. Some use-cases and APIs might not be reflected yet, so feel free to adapt the file as you see fit for your app.
As with every file fork, if you keep the changes git trackable, it's pretty straight-forward to pull in upstream changes later on.
ReScript > 8.3 now supports filenames with special characters: e.g. pages/blog/[slug].res.
If you can't upgrade yet, you can create a e.g. pages/blog/[slug].js file, a re_pages/blog_slug.re file and then reexport the React component within the [slug].js file.
We recommend upgrading to the newest ReScript (bs-platform) version as soon as possible to get the best experience for Next!
Make sure to create interface files (.resi) for each page/*.res file.
Fast Refresh requires you to only export React components, and it's easy to unintenionally export other values than that.
For the 100% "always-works-method", we recommend putting your ReScript components in e.g. the src directory, and re-export them in plain pages/*.js files instead (check out the templates initial pages directory to see how we forward our React components to make sure we fulfill the Fast-Refresh naming conventions).
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.
If you completely disagree with this, you can delete the emitted .js files within the src directory and add src/**/*.js in your .gitignore of course.
This template was created through our learnings of building the ReScript Documentation Platform (which is built in NextJS), and is maintained by one of the ReScript core team members. It irregularly receives updates depending on demand and urgency (e.g. important changes in the Next.res bindings, or package dependencies).