From 2a30904fe32cc252d2f217c4b7c25ca2699abb61 Mon Sep 17 00:00:00 2001 From: Nate Moore Date: Sun, 27 Mar 2022 09:30:12 -0500 Subject: [PATCH] feat: add router package and example --- examples/router/.gitignore | 17 ++++++ examples/router/.npmrc | 2 + examples/router/.stackblitzrc | 6 ++ examples/router/.vscode/extensions.json | 4 ++ examples/router/.vscode/launch.json | 11 ++++ examples/router/README.md | 43 ++++++++++++++ examples/router/astro.config.mjs | 9 +++ examples/router/package.json | 18 ++++++ examples/router/public/favicon.ico | Bin 0 -> 4286 bytes examples/router/sandbox.config.json | 11 ++++ examples/router/src/pages/index.astro | 28 +++++++++ .../src/pages/routes/dashboard/one.astro | 3 + .../src/pages/routes/dashboard/three.astro | 3 + .../src/pages/routes/dashboard/two.astro | 3 + .../router/src/pages/routes/tabs/about.astro | 3 + .../src/pages/routes/tabs/dashboard.astro | 15 +++++ examples/router/tsconfig.json | 5 ++ packages/router/Link.astro | 5 ++ packages/router/Outlet.astro | 25 ++++++++ packages/router/client.js | 54 ++++++++++++++++++ packages/router/index.js | 2 + packages/router/package.json | 30 ++++++++++ pnpm-lock.yaml | 14 +++++ 23 files changed, 311 insertions(+) create mode 100644 examples/router/.gitignore create mode 100644 examples/router/.npmrc create mode 100644 examples/router/.stackblitzrc create mode 100644 examples/router/.vscode/extensions.json create mode 100644 examples/router/.vscode/launch.json create mode 100644 examples/router/README.md create mode 100644 examples/router/astro.config.mjs create mode 100644 examples/router/package.json create mode 100644 examples/router/public/favicon.ico create mode 100644 examples/router/sandbox.config.json create mode 100644 examples/router/src/pages/index.astro create mode 100644 examples/router/src/pages/routes/dashboard/one.astro create mode 100644 examples/router/src/pages/routes/dashboard/three.astro create mode 100644 examples/router/src/pages/routes/dashboard/two.astro create mode 100644 examples/router/src/pages/routes/tabs/about.astro create mode 100644 examples/router/src/pages/routes/tabs/dashboard.astro create mode 100644 examples/router/tsconfig.json create mode 100644 packages/router/Link.astro create mode 100644 packages/router/Outlet.astro create mode 100644 packages/router/client.js create mode 100644 packages/router/index.js create mode 100644 packages/router/package.json diff --git a/examples/router/.gitignore b/examples/router/.gitignore new file mode 100644 index 0000000000..c824674530 --- /dev/null +++ b/examples/router/.gitignore @@ -0,0 +1,17 @@ +# build output +dist + +# dependencies +node_modules/ + +# logs +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# environment variables +.env +.env.production + +# macOS-specific files +.DS_Store diff --git a/examples/router/.npmrc b/examples/router/.npmrc new file mode 100644 index 0000000000..ef83021af3 --- /dev/null +++ b/examples/router/.npmrc @@ -0,0 +1,2 @@ +# Expose Astro dependencies for `pnpm` users +shamefully-hoist=true diff --git a/examples/router/.stackblitzrc b/examples/router/.stackblitzrc new file mode 100644 index 0000000000..43798ecff8 --- /dev/null +++ b/examples/router/.stackblitzrc @@ -0,0 +1,6 @@ +{ + "startCommand": "npm start", + "env": { + "ENABLE_CJS_IMPORTS": true + } +} \ No newline at end of file diff --git a/examples/router/.vscode/extensions.json b/examples/router/.vscode/extensions.json new file mode 100644 index 0000000000..22a15055d6 --- /dev/null +++ b/examples/router/.vscode/extensions.json @@ -0,0 +1,4 @@ +{ + "recommendations": ["astro-build.astro-vscode"], + "unwantedRecommendations": [] +} diff --git a/examples/router/.vscode/launch.json b/examples/router/.vscode/launch.json new file mode 100644 index 0000000000..d642209762 --- /dev/null +++ b/examples/router/.vscode/launch.json @@ -0,0 +1,11 @@ +{ + "version": "0.2.0", + "configurations": [ + { + "command": "./node_modules/.bin/astro dev", + "name": "Development server", + "request": "launch", + "type": "node-terminal" + } + ] +} diff --git a/examples/router/README.md b/examples/router/README.md new file mode 100644 index 0000000000..c9ef38ea6e --- /dev/null +++ b/examples/router/README.md @@ -0,0 +1,43 @@ +# Astro Starter Kit: Minimal + +``` +npm init astro -- --template minimal +``` + +[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal) + +> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! + +## 🚀 Project Structure + +Inside of your Astro project, you'll see the following folders and files: + +``` +/ +├── public/ +├── src/ +│ └── pages/ +│ └── index.astro +└── package.json +``` + +Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. + +There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. + +Any static assets, like images, can be placed in the `public/` directory. + +## 🧞 Commands + +All commands are run from the root of the project, from a terminal: + +| Command | Action | +|:---------------- |:-------------------------------------------- | +| `npm install` | Installs dependencies | +| `npm run dev` | Starts local dev server at `localhost:3000` | +| `npm run build` | Build your production site to `./dist/` | +| `npm run preview` | Preview your build locally, before deploying | + +## 👀 Want to learn more? + +Feel free to check [our documentation](https://github.com/withastro/astro) or jump into our [Discord server](https://astro.build/chat). diff --git a/examples/router/astro.config.mjs b/examples/router/astro.config.mjs new file mode 100644 index 0000000000..b73a6aeae1 --- /dev/null +++ b/examples/router/astro.config.mjs @@ -0,0 +1,9 @@ +import { defineConfig } from 'astro/config'; +import spa from "@astrojs/spa"; + +// https://astro.build/config +export default defineConfig({ + integrations: [ + spa() + ] +}); diff --git a/examples/router/package.json b/examples/router/package.json new file mode 100644 index 0000000000..1023391692 --- /dev/null +++ b/examples/router/package.json @@ -0,0 +1,18 @@ +{ + "name": "@example/router", + "version": "0.0.1", + "private": true, + "scripts": { + "dev": "astro dev", + "start": "astro dev", + "build": "astro build", + "preview": "astro preview" + }, + "devDependencies": { + "@astrojs/spa": "^0.0.1", + "astro": "^0.25.2" + }, + "dependencies": { + "@astrojs/router": "^0.0.1" + } +} diff --git a/examples/router/public/favicon.ico b/examples/router/public/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..578ad458b8906c08fbed84f42b045fea04db89d1 GIT binary patch literal 4286 zcmchZF=!M)6ox0}Fc8GdTHG!cdIY>nA!3n2f|wxIl0rn}Hl#=uf>?-!2r&jMEF^_k zh**lGut*gwBmoNv7AaB&2~nbzULg{WBhPQ{ZVzvF_HL8Cb&hv$_s#qN|IO^o>?+mA zuTW6tU%k~z<&{z+7$G%*nRsTcEO|90xy<-G5&JTt%CgZZCDT4%R?+{Vd^wh>P8_)} z`+dF$HQb9!>1o`Ivn;GInlCw{9T@Rt%q+d^T3Ke%cxkk;$v`{s^zCB9nHAv6w$Vbn z8fb<+eQTNM`;rf9#obfGnV#3+OQEUv4gU;{oA@zol%keY9-e>4W>p7AHmH~&!P7f7!Uj` zwgFeQ=<3G4O;mwWO`L!=R-=y3_~-DPjH3W^3f&jjCfC$o#|oGaahSL`_=f?$&Aa+W z2h8oZ+@?NUcjGW|aWJfbM*ZzxzmCPY`b~RobNrrj=rd`=)8-j`iSW64@0_b6?;GYk zNB+-fzOxlqZ?`y{OA$WigtZXa8)#p#=DPYxH=VeC_Q5q9Cv`mvW6*zU&Gnp1;oPM6 zaK_B3j(l^FyJgYeE9RrmDyhE7W2}}nW%ic#0v@i1E!yTey$W)U>fyd+!@2hWQ!Wa==NAtKoj`f3tp4y$Al`e;?)76?AjdaRR>|?&r)~3Git> zb1)a?uiv|R0_{m#A9c;7)eZ1y6l@yQ#oE*>(Z2fG-&&smPa2QTW>m*^K65^~`coP$ z8y5Y?iS<4Gz{Zg##$1mk)u-0;X|!xu^FCr;ce~X<&UWE&pBgqfYmEJTzpK9I%vr%b z3Ksd6qlPJLI%HFfeXK_^|BXiKZC>Ocu(Kk6hD3G-8usLzVG^q00Qh gz)s7ge@$ApxGu7=(6IGIk+uG&HTev01^#CH3$(Wk5&!@I literal 0 HcmV?d00001 diff --git a/examples/router/sandbox.config.json b/examples/router/sandbox.config.json new file mode 100644 index 0000000000..9178af77d7 --- /dev/null +++ b/examples/router/sandbox.config.json @@ -0,0 +1,11 @@ +{ + "infiniteLoopProtection": true, + "hardReloadOnChange": false, + "view": "browser", + "template": "node", + "container": { + "port": 3000, + "startScript": "start", + "node": "14" + } +} diff --git a/examples/router/src/pages/index.astro b/examples/router/src/pages/index.astro new file mode 100644 index 0000000000..0a3fa422f9 --- /dev/null +++ b/examples/router/src/pages/index.astro @@ -0,0 +1,28 @@ +--- +import { Link, Outlet } from '@astrojs/router'; +--- + + + + Router + +