docs: add solid-router basic example

oedotme · Nov 5, 2022 · ec47881 · ec47881
1 parent 43ddea4
commit ec47881
Show file tree

Hide file tree

Showing 12 changed files with 107 additions and 0 deletions.
diff --git a/examples/solid-router/basic/.gitignore b/examples/solid-router/basic/.gitignore
@@ -0,0 +1,2 @@
+dist
+node_modules
diff --git a/examples/solid-router/basic/index.html b/examples/solid-router/basic/index.html
@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Generouted - Basic example</title>
+  </head>
+
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>
diff --git a/examples/solid-router/basic/package.json b/examples/solid-router/basic/package.json
@@ -0,0 +1,21 @@
+{
+  "name": "basic",
+  "version": "1.0.0",
+  "description": "Generated file-based routes for Solid Router and Vite basic example",
+  "author": "Omar Elhawary <[email protected]> (https://omarelhawary.me)",
+  "license": "MIT",
+  "scripts": {
+    "dev": "vite dev --port 3000",
+    "build": "vite build"
+  },
+  "dependencies": {
+    "@solidjs/router": "^0.5.0",
+    "generouted": "workspace:*",
+    "solid-js": "^1.6.1"
+  },
+  "devDependencies": {
+    "typescript": "^4.8.3",
+    "vite": "^3.1.2",
+    "vite-plugin-solid": "^2.3.10"
+  }
+}
diff --git a/examples/solid-router/basic/src/main.tsx b/examples/solid-router/basic/src/main.tsx
@@ -0,0 +1,4 @@
+import { render } from 'solid-js/web'
+import { Routes } from 'generouted/solid-router'
+
+render(Routes, document.getElementById('app') as HTMLElement)
diff --git a/examples/solid-router/basic/src/pages/404.tsx b/examples/solid-router/basic/src/pages/404.tsx
@@ -0,0 +1,3 @@
+export default function NotFound() {
+  return <h1>404</h1>
+}
diff --git a/examples/solid-router/basic/src/pages/_app.tsx b/examples/solid-router/basic/src/pages/_app.tsx
@@ -0,0 +1,15 @@
+import { ParentProps } from 'solid-js'
+import { A } from '@solidjs/router'
+
+export default function App(props: ParentProps) {
+  return (
+    <section style={{ margin: '24px' }}>
+      <header style={{ display: 'flex', gap: '24px' }}>
+        <A href="/">Home</A>
+        <A href="/about">About</A>
+      </header>
+
+      <main>{props.children}</main>
+    </section>
+  )
+}
diff --git a/examples/solid-router/basic/src/pages/about.tsx b/examples/solid-router/basic/src/pages/about.tsx
@@ -0,0 +1,3 @@
+export default function About() {
+  return <h1>About - Basic</h1>
+}
diff --git a/examples/solid-router/basic/src/pages/index.tsx b/examples/solid-router/basic/src/pages/index.tsx
@@ -0,0 +1,3 @@
+export default function Home() {
+  return <h1>Home - Basic</h1>
+}
diff --git a/examples/solid-router/basic/tsconfig.json b/examples/solid-router/basic/tsconfig.json
@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "target": "es2017",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "jsxImportSource": "solid-js",
+    "types": ["vite/client"]
+  },
+  "include": ["./src"]
+}
diff --git a/examples/solid-router/basic/vite.config.ts b/examples/solid-router/basic/vite.config.ts
@@ -0,0 +1,4 @@
+import { defineConfig } from 'vite'
+import solid from 'vite-plugin-solid'
+
+export default defineConfig({ plugins: [solid()] })
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml
@@ -1,3 +1,4 @@
 packages:
   - examples/react-location/*
   - examples/react-router/*
+  - examples/solid-router/*