├── src ├── components │ └── .gitkeep ├── Index.resi ├── App.resi ├── layouts │ ├── MainLayout.resi │ ├── MainLayout.res │ └── MainLayout.mjs ├── Examples.resi ├── Examples.res ├── bindings │ ├── Next.mjs │ └── Next.res ├── Index.res ├── Examples.mjs ├── App.mjs ├── Index.mjs └── App.res ├── .nowignore ├── jsconfig.json ├── now.json ├── .babelrc ├── .gitignore ├── styles ├── main.css └── _fonts.css ├── postcss.config.js ├── pages ├── index.js ├── examples.js └── _app.js ├── bsconfig.json ├── public └── static │ └── zeit-black-triangle.svg ├── package.json ├── next.config.js ├── tailwind.config.js ├── README.md └── LICENSE /src/components/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.nowignore: -------------------------------------------------------------------------------- 1 | .next/ 2 | node_modules/ 3 | -------------------------------------------------------------------------------- /src/Index.resi: -------------------------------------------------------------------------------- 1 | let default: unit => React.element 2 | -------------------------------------------------------------------------------- /src/App.resi: -------------------------------------------------------------------------------- 1 | type props 2 | let default: props => React.element 3 | -------------------------------------------------------------------------------- /jsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "baseUrl": "." 4 | } 5 | } 6 | -------------------------------------------------------------------------------- /now.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": 2, 3 | "github": { 4 | "silent": true 5 | } 6 | } 7 | -------------------------------------------------------------------------------- /.babelrc: -------------------------------------------------------------------------------- 1 | { 2 | "presets": [ 3 | "next/babel" 4 | ], 5 | "plugins": [ 6 | ] 7 | } 8 | -------------------------------------------------------------------------------- /src/layouts/MainLayout.resi: -------------------------------------------------------------------------------- 1 | @react.component 2 | let make: (~children: React.element) => React.element 3 | -------------------------------------------------------------------------------- /src/Examples.resi: -------------------------------------------------------------------------------- 1 | type props 2 | let default: props => React.element 3 | let getServerSideProps: Next.GetServerSideProps.t 4 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | out 2 | 3 | .DS_Store 4 | *.swp 5 | *.swo 6 | 7 | node_modules/ 8 | .next/ 9 | 10 | yarn-error.log 11 | 12 | .bsb.lock 13 | .merlin 14 | lib/ 15 | -------------------------------------------------------------------------------- /styles/main.css: -------------------------------------------------------------------------------- 1 | @tailwind base; 2 | @tailwind components; 3 | 4 | @import "./_fonts.css"; 5 | 6 | body { 7 | @apply font-sans bg-white; 8 | } 9 | 10 | @tailwind utilities; 11 | -------------------------------------------------------------------------------- /postcss.config.js: -------------------------------------------------------------------------------- 1 | const plugins ={ 2 | tailwindcss: {}, 3 | autoprefixer: {} 4 | }; 5 | 6 | if(process.env.NODE_ENV === 'production') { 7 | plugins.cssnano = {}; 8 | } 9 | 10 | module.exports = { 11 | plugins: plugins 12 | }; 13 | -------------------------------------------------------------------------------- /pages/index.js: -------------------------------------------------------------------------------- 1 | import IndexRes from "src/Index.mjs"; 2 | 3 | // Note: 4 | // We need to wrap the make call with 5 | // a Fast-Refresh conform function name, 6 | // (in this case, uppercased first letter) 7 | // 8 | // If you don't do this, your Fast-Refresh will 9 | // not work! 10 | export default function Index(props) { 11 | return ; 12 | } 13 | -------------------------------------------------------------------------------- /pages/examples.js: -------------------------------------------------------------------------------- 1 | import ExamplesRes from "src/Examples.mjs"; 2 | 3 | // This can be re-exported as is (no Fast-Refresh issues) 4 | export { getServerSideProps } from "src/Examples.mjs"; 5 | 6 | // Note: 7 | // We need to wrap the make call with 8 | // a Fast-Refresh conform function name, 9 | // (in this case, uppercased first letter) 10 | // 11 | // If you don't do this, your Fast-Refresh will 12 | // not work! 13 | export default function Examples(props) { 14 | return ; 15 | } 16 | -------------------------------------------------------------------------------- /bsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "rescript-nextjs-template", 3 | "namespace": false, 4 | "reason": { "react-jsx": 3 }, 5 | "refmt": 3, 6 | "bs-dependencies": ["@rescript/react"], 7 | "ppx-flags": [], 8 | "sources": [ 9 | { "dir": "src", "subdirs": true } 10 | ], 11 | "package-specs": { 12 | "module": "es6", 13 | "in-source": true 14 | }, 15 | "suffix": ".mjs", 16 | "warnings": { 17 | "number": "-3", 18 | "error": "+101+8" 19 | }, 20 | "gentypeconfig": { 21 | "language": "untyped", 22 | "shims": [] 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /src/Examples.res: -------------------------------------------------------------------------------- 1 | type props = { 2 | msg: string, 3 | href: string, 4 | } 5 | 6 | let default = (props: props) => 7 |
8 | {React.string(props.msg)} 9 | {React.string("`src/Examples.res`")} 10 |
11 | 12 | let getServerSideProps = _ctx => { 13 | let props = { 14 | msg: "This page was rendered with getServerSideProps. You can find the source code here: ", 15 | href: "https://github.com/ryyppy/nextjs-default/tree/master/src/Examples.res", 16 | } 17 | Js.Promise.resolve({"props": props}) 18 | } 19 | -------------------------------------------------------------------------------- /pages/_app.js: -------------------------------------------------------------------------------- 1 | import 'styles/main.css' 2 | 3 | // Note: 4 | // Just renaming $$default to ResApp alone 5 | // doesn't help FastRefresh to detect the 6 | // React component, since an alias isn't attached 7 | // to the original React component function name. 8 | import ResApp from "src/App.mjs" 9 | 10 | // Note: 11 | // We need to wrap the make call with 12 | // a Fast-Refresh conform function name, 13 | // (in this case, uppercased first letter) 14 | // 15 | // If you don't do this, your Fast-Refresh will 16 | // not work! 17 | export default function App(props) { 18 | return ; 19 | } 20 | -------------------------------------------------------------------------------- /styles/_fonts.css: -------------------------------------------------------------------------------- 1 | /* 2 | This file is dedicated for your own font-faces. 3 | 4 | --- 5 | Example of using a google font as a self hosted .woff file 6 | 7 | @font-face { 8 | font-family: 'Source Sans Pro'; 9 | font-style: normal; 10 | font-weight: 400; 11 | font-display: swap; 12 | src: local('Source Sans Pro Regular'), local('SourceSansPro-Regular'), url(/static/fonts/source-sans-pro-regular.woff2) format('woff2'); 13 | unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD; 14 | } 15 | */ 16 | -------------------------------------------------------------------------------- /src/bindings/Next.mjs: -------------------------------------------------------------------------------- 1 | // Generated by ReScript, PLEASE EDIT WITH CARE 2 | 3 | 4 | var Req = {}; 5 | 6 | var Res = {}; 7 | 8 | var GetServerSideProps = { 9 | Req: Req, 10 | Res: Res 11 | }; 12 | 13 | var GetStaticProps = {}; 14 | 15 | var GetStaticPaths = {}; 16 | 17 | var Link = {}; 18 | 19 | var Events = {}; 20 | 21 | var Router = { 22 | Events: Events 23 | }; 24 | 25 | var Head = {}; 26 | 27 | var $$Error = {}; 28 | 29 | var Dynamic = {}; 30 | 31 | export { 32 | GetServerSideProps , 33 | GetStaticProps , 34 | GetStaticPaths , 35 | Link , 36 | Router , 37 | Head , 38 | $$Error , 39 | Dynamic , 40 | 41 | } 42 | /* No side effect */ 43 | -------------------------------------------------------------------------------- /src/Index.res: -------------------------------------------------------------------------------- 1 | module P = { 2 | @react.component 3 | let make = (~children) =>

children

4 | } 5 | 6 | let default = () => 7 |
8 |

{"What is this about?"->React.string}

9 |

10 | {React.string(` This is a simple template for a Next 11 | project using ReScript & TailwindCSS.`)} 12 |

13 |

{React.string("Quick Start")}

14 | 
15 |       {React.string(`git clone https://github.com/rescript-nextjs-template.git my-project
16 | cd my-project
17 | rm -rf .git`)} //github.com/ryyppy/nextjs-default.git my-project
18 |
19 |
20 | -------------------------------------------------------------------------------- /src/Examples.mjs: -------------------------------------------------------------------------------- 1 | // Generated by ReScript, PLEASE EDIT WITH CARE 2 | 3 | import * as React from "react"; 4 | 5 | function $$default(props) { 6 | return React.createElement("div", undefined, props.msg, React.createElement("a", { 7 | href: props.href, 8 | target: "_blank" 9 | }, "`src/Examples.res`")); 10 | } 11 | 12 | function getServerSideProps(_ctx) { 13 | return Promise.resolve({ 14 | props: { 15 | msg: "This page was rendered with getServerSideProps. You can find the source code here: ", 16 | href: "https://github.com/ryyppy/nextjs-default/tree/master/src/Examples.res" 17 | } 18 | }); 19 | } 20 | 21 | export { 22 | $$default , 23 | $$default as default, 24 | getServerSideProps , 25 | 26 | } 27 | /* react Not a pure module */ 28 | -------------------------------------------------------------------------------- /src/App.mjs: -------------------------------------------------------------------------------- 1 | // Generated by ReScript, PLEASE EDIT WITH CARE 2 | 3 | import * as React from "react"; 4 | import * as MainLayout from "./layouts/MainLayout.mjs"; 5 | import * as Router from "next/router"; 6 | 7 | function $$default(props) { 8 | var router = Router.useRouter(); 9 | var content = React.createElement(props.Component, props.pageProps); 10 | var match = router.route; 11 | if (match === "/examples") { 12 | return React.createElement(MainLayout.make, { 13 | children: null 14 | }, React.createElement("h1", { 15 | className: "font-bold" 16 | }, "Examples Section"), React.createElement("div", undefined, content)); 17 | } else { 18 | return React.createElement(MainLayout.make, { 19 | children: content 20 | }); 21 | } 22 | } 23 | 24 | export { 25 | $$default , 26 | $$default as default, 27 | 28 | } 29 | /* react Not a pure module */ 30 | -------------------------------------------------------------------------------- /public/static/zeit-black-triangle.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Logotype - Black 5 | Created with Sketch. 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /src/Index.mjs: -------------------------------------------------------------------------------- 1 | // Generated by ReScript, PLEASE EDIT WITH CARE 2 | 3 | import * as React from "react"; 4 | 5 | function Index$P(Props) { 6 | var children = Props.children; 7 | return React.createElement("p", { 8 | className: "mb-2" 9 | }, children); 10 | } 11 | 12 | function $$default(param) { 13 | return React.createElement("div", undefined, React.createElement("h1", { 14 | className: "text-3xl font-semibold" 15 | }, "What is this about?"), React.createElement(Index$P, { 16 | children: " This is a simple template for a Next\n project using ReScript & TailwindCSS." 17 | }), React.createElement("h2", { 18 | className: "text-2xl font-semibold mt-5" 19 | }, "Quick Start"), React.createElement("pre", undefined, "git clone https://github.com/rescript-nextjs-template.git my-project\ncd my-project\nrm -rf .git")); 20 | } 21 | 22 | export { 23 | $$default , 24 | $$default as default, 25 | 26 | } 27 | /* react Not a pure module */ 28 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "rescript-nextjs-template", 3 | "version": "1.0.0", 4 | "author": "Patrick Ecker ", 5 | "license": "Apache-2.0", 6 | "dependencies": { 7 | "next": "10.2.3", 8 | "react": "17.0.1", 9 | "react-dom": "17.0.1" 10 | }, 11 | "repository": "https://github.com/ryyppy/rescript-nextjs-template", 12 | "scripts": { 13 | "dev": "next", 14 | "debug": "NODE_OPTIONS='--inspect' next", 15 | "build": "rescript && next build", 16 | "now-build": "rescript && next build", 17 | "export": "next export", 18 | "start": "next start -p $PORT", 19 | "res:build": "rescript", 20 | "res:clean": "rescript clean", 21 | "res:start": "rescript build -w" 22 | }, 23 | "devDependencies": { 24 | "next-transpile-modules": "7.1.2", 25 | "@rescript/react": "0.10.3", 26 | "gentype": "4.1", 27 | "autoprefixer": "10.1.0", 28 | "rescript": "9.1", 29 | "cssnano": "5.0.5", 30 | "postcss": "8.2.15", 31 | "postcss-cli": "8.3.1", 32 | "tailwindcss": "2.0.4" 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /src/App.res: -------------------------------------------------------------------------------- 1 | // This type is based on the getInitialProps return value. 2 | // If you are using getServerSideProps or getStaticProps, you probably 3 | // will never need this 4 | // See https://nextjs.org/docs/advanced-features/custom-app 5 | type pageProps 6 | 7 | module PageComponent = { 8 | type t = React.component 9 | } 10 | 11 | type props = { 12 | @as("Component") 13 | component: PageComponent.t, 14 | pageProps: pageProps, 15 | } 16 | 17 | 18 | // We are not using `@react.component` since we will never 19 | // use within our ReScript code. 20 | // It's only used within `pages/_app.js` 21 | let default = (props: props): React.element => { 22 | let {component, pageProps} = props 23 | 24 | let router = Next.Router.useRouter() 25 | 26 | let content = React.createElement(component, pageProps) 27 | 28 | switch router.route { 29 | | "/examples" => 30 | 31 |

{React.string("Examples Section")}

content
32 | 33 | | _ => content 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /next.config.js: -------------------------------------------------------------------------------- 1 | const bsconfig = require('./bsconfig.json'); 2 | const fs = require("fs"); 3 | 4 | const transpileModules = ["rescript"].concat(bsconfig["bs-dependencies"]); 5 | const withTM = require("next-transpile-modules")(transpileModules); 6 | 7 | const isWebpack5 = true; 8 | const config = { 9 | target: "serverless", 10 | pageExtensions: ["jsx", "js"], 11 | env: { 12 | ENV: process.env.NODE_ENV, 13 | }, 14 | webpack: (config, options) => { 15 | const { isServer } = options; 16 | 17 | if (isWebpack5) { 18 | if (!isServer) { 19 | // We shim fs for things like the blog slugs component 20 | // where we need fs access in the server-side part 21 | config.resolve.fallback = { 22 | fs: false, 23 | path: false, 24 | }; 25 | } 26 | 27 | // We need this additional rule to make sure that mjs files are 28 | // correctly detected within our src/ folder 29 | config.module.rules.push({ 30 | test: /\.m?js$/, 31 | use: options.defaultLoaders.babel, 32 | exclude: /node_modules/, 33 | type: "javascript/auto", 34 | resolve: { 35 | fullySpecified: false, 36 | } 37 | }); 38 | } 39 | return config 40 | }, 41 | future: { 42 | webpack5: isWebpack5 43 | } 44 | }; 45 | 46 | module.exports = withTM(config); 47 | -------------------------------------------------------------------------------- /tailwind.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | purge: { 3 | // Specify the paths to all of the template files in your project 4 | content: [ 5 | './src/components/**/*.res', 6 | './src/layouts/**/*.res', 7 | './src/*.res', 8 | ], 9 | options: { 10 | safelist: ["html", "body"], 11 | } 12 | }, 13 | darkMode: false, // or 'media' or 'class' 14 | theme: { 15 | extend: { 16 | }, 17 | /* Most of the time we customize the font-sizes, 18 | so we added the Tailwind default values here for 19 | convenience */ 20 | fontSize: { 21 | xs: ".75rem", 22 | sm: ".875rem", 23 | base: "1rem", 24 | lg: "1.125rem", 25 | xl: "1.25rem", 26 | '2xl': "1.5rem", 27 | '3xl': "1.875rem", 28 | '4xl': "2.25rem", 29 | '5xl': "3rem", 30 | '6xl': "4rem" 31 | }, 32 | /* We override the default font-families with our own default prefs */ 33 | fontFamily: { 34 | 'sans':['-apple-system', 'BlinkMacSystemFont', 'Helvetica Neue', 'Arial', 'sans-serif'], 35 | 'serif': ['Georgia', '-apple-system', 'BlinkMacSystemFont', 'Helvetica Neue', 'Arial', 'sans-serif'], 36 | 'mono': [ 'Menlo', 'Monaco', 'Consolas', 'Roboto Mono', 'SFMono-Regular', 'Segoe UI', 'Courier', 'monospace'] 37 | }, 38 | }, 39 | variants: { 40 | width: ['responsive'] 41 | }, 42 | plugins: [] 43 | } 44 | -------------------------------------------------------------------------------- /src/layouts/MainLayout.res: -------------------------------------------------------------------------------- 1 | module Link = Next.Link 2 | 3 | module Navigation = { 4 | @react.component 5 | let make = () => 6 | 26 | } 27 | 28 | @react.component 29 | let make = (~children) => { 30 | let minWidth = ReactDOM.Style.make(~minWidth="20rem", ()) 31 |
32 |
33 |
children
34 |
35 |
36 | } 37 | -------------------------------------------------------------------------------- /src/layouts/MainLayout.mjs: -------------------------------------------------------------------------------- 1 | // Generated by ReScript, PLEASE EDIT WITH CARE 2 | 3 | import * as React from "react"; 4 | import Link from "next/link"; 5 | 6 | function MainLayout$Navigation(Props) { 7 | return React.createElement("nav", { 8 | className: "p-2 h-12 flex border-b border-gray-200 justify-between items-center text-sm" 9 | }, React.createElement(Link, { 10 | href: "/", 11 | children: React.createElement("a", { 12 | className: "flex items-center w-1/3" 13 | }, React.createElement("img", { 14 | className: "w-5", 15 | src: "/static/zeit-black-triangle.svg" 16 | }), React.createElement("span", { 17 | className: "text-xl ml-2 align-middle font-semibold" 18 | }, "Next", React.createElement("span", { 19 | className: "text-orange-800" 20 | }, " + ReScript"))) 21 | }), React.createElement("div", { 22 | className: "flex w-2/3 justify-end" 23 | }, React.createElement(Link, { 24 | href: "/", 25 | children: React.createElement("a", { 26 | className: "px-3" 27 | }, "Home") 28 | }), React.createElement(Link, { 29 | href: "/examples", 30 | children: React.createElement("a", { 31 | className: "px-3" 32 | }, "Examples") 33 | }), React.createElement("a", { 34 | className: "px-3 font-bold", 35 | href: "https://github.com/ryyppy/nextjs-default", 36 | target: "_blank" 37 | }, "Github"))); 38 | } 39 | 40 | function MainLayout(Props) { 41 | var children = Props.children; 42 | var minWidth = { 43 | minWidth: "20rem" 44 | }; 45 | return React.createElement("div", { 46 | className: "flex lg:justify-center", 47 | style: minWidth 48 | }, React.createElement("div", { 49 | className: "max-w-5xl w-full lg:w-3/4 text-gray-900 font-base" 50 | }, React.createElement(MainLayout$Navigation, {}), React.createElement("main", { 51 | className: "mt-4 mx-4" 52 | }, children))); 53 | } 54 | 55 | var make = MainLayout; 56 | 57 | export { 58 | make , 59 | 60 | } 61 | /* react Not a pure module */ 62 | -------------------------------------------------------------------------------- /src/bindings/Next.res: -------------------------------------------------------------------------------- 1 | module GetServerSideProps = { 2 | module Req = { 3 | type t 4 | } 5 | 6 | module Res = { 7 | type t 8 | 9 | @send external setHeader: (t, string, string) => unit = "setHeader" 10 | @send external write: (t, string) => unit = "write" 11 | @send external end: t => unit = "end" 12 | } 13 | 14 | // See: https://github.com/zeit/next.js/blob/canary/packages/next/types/index.d.ts 15 | type context<'props, 'params, 'previewData> = { 16 | params: 'params, 17 | query: Js.Dict.t, 18 | preview: option, // preview is true if the page is in the preview mode and undefined otherwise. 19 | previewData: Js.Nullable.t<'previewData>, 20 | req: Req.t, 21 | res: Res.t, 22 | } 23 | 24 | // The definition of a getServerSideProps function 25 | type t<'props, 'params, 'previewData> = context<'props, 'params, 'previewData> => Js.Promise.t<{"props": 'props}> 26 | } 27 | 28 | module GetStaticProps = { 29 | // See: https://github.com/zeit/next.js/blob/canary/packages/next/types/index.d.ts 30 | type context<'props, 'params, 'previewData> = { 31 | params: 'params, 32 | preview: option, // preview is true if the page is in the preview mode and undefined otherwise. 33 | previewData: Js.Nullable.t<'previewData>, 34 | } 35 | 36 | // The definition of a getStaticProps function 37 | type t<'props, 'params, 'previewData> = context<'props, 'params, 'previewData> => Js.Promise.t<{ 38 | "props": 'props, 39 | }> 40 | } 41 | 42 | module GetStaticPaths = { 43 | // 'params: dynamic route params used in dynamic routing paths 44 | // Example: pages/[id].js would result in a 'params = { id: string } 45 | type path<'params> = {params: 'params} 46 | 47 | type return<'params> = { 48 | paths: array>, 49 | fallback: bool, 50 | } 51 | 52 | // The definition of a getStaticPaths function 53 | type t<'params> = unit => Js.Promise.t> 54 | } 55 | 56 | module Link = { 57 | @module("next/link") @react.component 58 | external make: ( 59 | ~href: string, 60 | ~_as: string=?, 61 | ~prefetch: bool=?, 62 | ~replace: option=?, 63 | ~shallow: option=?, 64 | ~passHref: option=?, 65 | ~children: React.element, 66 | ) => React.element = "default" 67 | } 68 | 69 | module Router = { 70 | /* 71 | Make sure to only register events via a useEffect hook! 72 | */ 73 | module Events = { 74 | type t 75 | 76 | @send 77 | external on: ( 78 | t, 79 | @string 80 | [ 81 | | #routeChangeStart(string => unit) 82 | | #routeChangeComplete(string => unit) 83 | | #hashChangeComplete(string => unit) 84 | ], 85 | ) => unit = "on" 86 | 87 | @send 88 | external off: ( 89 | t, 90 | @string 91 | [ 92 | | #routeChangeStart(string => unit) 93 | | #routeChangeComplete(string => unit) 94 | | #hashChangeComplete(string => unit) 95 | ], 96 | ) => unit = "off" 97 | } 98 | 99 | type router = { 100 | route: string, 101 | asPath: string, 102 | events: Events.t, 103 | pathname: string, 104 | query: Js.Dict.t, 105 | } 106 | 107 | type pathObj = { 108 | pathname: string, 109 | query: Js.Dict.t, 110 | } 111 | 112 | @send external push: (router, string) => unit = "push" 113 | @send external pushObj: (router, pathObj) => unit = "push" 114 | 115 | @module("next/router") external useRouter: unit => router = "useRouter" 116 | 117 | @send external replace: (router, string) => unit = "replace" 118 | @send external replaceObj: (router, pathObj) => unit = "replace" 119 | } 120 | 121 | module Head = { 122 | @module("next/head") @react.component 123 | external make: (~children: React.element) => React.element = "default" 124 | } 125 | 126 | module Error = { 127 | @module("next/error") @react.component 128 | external make: (~statusCode: int, ~children: React.element) => React.element = "default" 129 | } 130 | 131 | module Dynamic = { 132 | @deriving(abstract) 133 | type options = { 134 | @optional 135 | ssr: bool, 136 | @optional 137 | loading: unit => React.element, 138 | } 139 | 140 | @module("next/dynamic") 141 | external dynamic: (unit => Js.Promise.t<'a>, options) => 'a = "default" 142 | 143 | @val external import_: string => Js.Promise.t<'a> = "import" 144 | } 145 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ReScript / NextJS Starter 2 | 3 | This is a NextJS based template with following setup: 4 | 5 | - Full Tailwind v2 config & basic css scaffold (+ production setup w/ purge-css & cssnano) 6 | - [ReScript](https://rescript-lang.org) + React 7 | - Some ReScript Bindings for Next to get you started 8 | - Preconfigured Dependencies: `@rescript/react` 9 | 10 | **Note:** This setup is based on the `v1` `package-lock` format utilized by `npm@6`. If you want to use the newer `v2` version, delete the `package-lock.json` file and install the dependencies with `npm@7`. 11 | 12 | ## Development 13 | 14 | Run ReScript in dev mode: 15 | 16 | ``` 17 | npm run res:start 18 | ``` 19 | 20 | In another tab, run the Next dev server: 21 | 22 | ``` 23 | npm run dev 24 | ``` 25 | 26 | ## Useful commands 27 | 28 | Build CSS seperately via `postcss` (useful for debugging) 29 | 30 | ``` 31 | # Devmode 32 | npx postcss styles/main.css -o test.css 33 | 34 | # Production 35 | NODE_ENV=production npx postcss styles/main.css -o test.css 36 | ``` 37 | 38 | ## Test production setup with Next 39 | 40 | ``` 41 | # Make sure to uncomment the `target` attribute in `now.json` first, before you run this: 42 | npm run build 43 | PORT=3001 npm start 44 | ``` 45 | 46 | ## Tips 47 | 48 | ### ES6 vs CommonJS 49 | 50 | This template is complying to the ES6 module format, and therefore compiles ReScript code to `mjs` files. In case you want to use this template with the old `commonjs` format, do the following changes: 51 | 52 | 1) Set `package-specs` and `suffix` to the following configuration: 53 | 54 | ```json 55 | { 56 | //... 57 | "package-specs": { 58 | "module": "commonjs", 59 | "in-source": true 60 | }, 61 | "suffix": ".bs.js", 62 | } 63 | ``` 64 | 65 | 2) Replace all import paths in `pages` that refer to `src/MyResFile.mjs` to `src/MyResFile.bs.js` 66 | 67 | ```diff 68 | // pages/_app.js 69 | +import ResApp from "src/App.mjs" 70 | +import ResApp from "src/App.bs.js" 71 | ``` 72 | 73 | Done. You are now running on commonjs modules. 74 | 75 | ### Don't be afraid to adapt your Next bindings 76 | 77 | 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. 78 | 79 | As with every file fork, if you keep the changes git trackable, it's pretty straight-forward to pull in upstream changes later on. 80 | 81 | ### Fast Refresh & ReScript 82 | 83 | Make sure to create interface files (`.resi`) for each `page/*.res` file. 84 | 85 | 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). 86 | 87 | 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). 88 | 89 | ### Filenames with special characters 90 | 91 | ReScript supports filenames with special characters: e.g. `pages/blog/[slug].res`, but be aware that you can't access these these modules within other modules (since there is no syntax to express modules with e.g. `[` characters). Also don't forget to create an additional `.resi` file to comply to Fast Refresh rules. 92 | 93 | ## Q & A 94 | 95 | ### Why are the generated `.mjs` files tracked in git? 96 | 97 | 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). 98 | 99 | 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. 100 | 101 | If you want to opt-out, feel free to remove all compiled `.mjs` files within the `src` directory and add `src/**/*.mjs` in your `.gitignore`. 102 | 103 | ### How trustworthy is this template? 104 | 105 | This template was created through our learnings of building the [ReScript Documentation Platform](https://rescript-lang.org) (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). 106 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------