current status

Author: Idrinth

.gitignore

@@ -0,0 +1,2 @@
+.idea
+node_modules

README.md

@@ -0,0 +1,20 @@
+# @idrinth/react-file-based-routing
+
+This is a small library used to teach the default react routers file based routing and optimise the output as far as that is possible without server side rendering. It is meant for mostly static pages, where the overhead of nextjs of vike is not required.
+
+## Defining a page
+
+A page is currently any ìndex.tsx within the src/pages folder. index.tsx in the root folder will not be processed correctly. The folder name will be taken as the page url, with two exceptions:
+
+- home will be the root
+- not-found will be the 404 page
+
+This is not yet configurable, but will be soon.
+
+# Setup
+
+You will need to do three things for the complete package:
+
+- Define a call to generate-routes in you package.json as afterInstall and early in your build process to generate the routes.tsx and the sitemap
+- Define a call to generate-folders in your package.json as a late build step to optimise the index.html files
+- Import the generated src/routes.tsx, so that you can use createBrowserRouter or similar functions to create your router

bin/generate-folders.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import generate from '../src/generate-folders.js';
+
+generate(process.cwd());

bin/generate-routes.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import generate from '../src/generate-routes.js';
+
+generate(process.cwd(), process.argv[2]);