From c46db4ecbd1dfbe68679167b27e7f1d92e27f5fb Mon Sep 17 00:00:00 2001 From: Joel Kuzmarski Date: Fri, 25 Feb 2022 10:18:48 -0600 Subject: [PATCH] Add Non-HTML Pages example (#2637) * Add Non-HTML Pages example * Rename dir non-html-example to non-html-pages * Update name to non-html-pages in package.json --- examples/non-html-pages/.gitignore | 17 +++++++ examples/non-html-pages/.npmrc | 2 + examples/non-html-pages/.stackblitzrc | 6 +++ examples/non-html-pages/README.md | 48 ++++++++++++++++++ examples/non-html-pages/astro.config.mjs | 8 +++ examples/non-html-pages/package.json | 14 +++++ examples/non-html-pages/public/favicon.ico | Bin 0 -> 4286 bytes examples/non-html-pages/sandbox.config.json | 11 ++++ .../non-html-pages/src/pages/company.json.ts | 9 ++++ examples/non-html-pages/src/pages/index.astro | 16 ++++++ examples/non-html-pages/tsconfig.json | 5 ++ 11 files changed, 136 insertions(+) create mode 100644 examples/non-html-pages/.gitignore create mode 100644 examples/non-html-pages/.npmrc create mode 100644 examples/non-html-pages/.stackblitzrc create mode 100644 examples/non-html-pages/README.md create mode 100644 examples/non-html-pages/astro.config.mjs create mode 100644 examples/non-html-pages/package.json create mode 100644 examples/non-html-pages/public/favicon.ico create mode 100644 examples/non-html-pages/sandbox.config.json create mode 100644 examples/non-html-pages/src/pages/company.json.ts create mode 100644 examples/non-html-pages/src/pages/index.astro create mode 100644 examples/non-html-pages/tsconfig.json diff --git a/examples/non-html-pages/.gitignore b/examples/non-html-pages/.gitignore new file mode 100644 index 000000000..c82467453 --- /dev/null +++ b/examples/non-html-pages/.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/non-html-pages/.npmrc b/examples/non-html-pages/.npmrc new file mode 100644 index 000000000..65922326b --- /dev/null +++ b/examples/non-html-pages/.npmrc @@ -0,0 +1,2 @@ +## force pnpm to hoist +shamefully-hoist = true diff --git a/examples/non-html-pages/.stackblitzrc b/examples/non-html-pages/.stackblitzrc new file mode 100644 index 000000000..43798ecff --- /dev/null +++ b/examples/non-html-pages/.stackblitzrc @@ -0,0 +1,6 @@ +{ + "startCommand": "npm start", + "env": { + "ENABLE_CJS_IMPORTS": true + } +} \ No newline at end of file diff --git a/examples/non-html-pages/README.md b/examples/non-html-pages/README.md new file mode 100644 index 000000000..354f95be3 --- /dev/null +++ b/examples/non-html-pages/README.md @@ -0,0 +1,48 @@ +# Astro Starter Kit: Non-HTML Pages + +Documentation for "Non-HTML Pages": + +https://docs.astro.build/en/core-concepts/astro-pages/#non-html-pages + +``` +npm init astro -- --template non-html-pages +``` + +[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/non-html-pages) + +> 🧑‍🚀 **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 +│ └── company.json.ts +└── 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/non-html-pages/astro.config.mjs b/examples/non-html-pages/astro.config.mjs new file mode 100644 index 000000000..67c95c240 --- /dev/null +++ b/examples/non-html-pages/astro.config.mjs @@ -0,0 +1,8 @@ +// Full Astro Configuration API Documentation: +// https://docs.astro.build/reference/configuration-reference + +// @ts-check +export default /** @type {import('astro').AstroUserConfig} */ ({ + // Comment out "renderers: []" to enable Astro's default component support. + renderers: [], +}); diff --git a/examples/non-html-pages/package.json b/examples/non-html-pages/package.json new file mode 100644 index 000000000..dd789703d --- /dev/null +++ b/examples/non-html-pages/package.json @@ -0,0 +1,14 @@ +{ + "name": "@example/non-html-pages", + "version": "0.0.1", + "private": true, + "scripts": { + "dev": "astro dev", + "start": "astro dev", + "build": "astro build", + "preview": "astro preview" + }, + "devDependencies": { + "astro": "^0.23.0-next.10" + } +} diff --git a/examples/non-html-pages/public/favicon.ico b/examples/non-html-pages/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/non-html-pages/sandbox.config.json b/examples/non-html-pages/sandbox.config.json new file mode 100644 index 000000000..9178af77d --- /dev/null +++ b/examples/non-html-pages/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/non-html-pages/src/pages/company.json.ts b/examples/non-html-pages/src/pages/company.json.ts new file mode 100644 index 000000000..ecff4458e --- /dev/null +++ b/examples/non-html-pages/src/pages/company.json.ts @@ -0,0 +1,9 @@ +export async function get() { + return { + body: JSON.stringify({ + name: 'Astro', + url: 'https://astro.build/', + }), + }; +} + diff --git a/examples/non-html-pages/src/pages/index.astro b/examples/non-html-pages/src/pages/index.astro new file mode 100644 index 000000000..af1ed4326 --- /dev/null +++ b/examples/non-html-pages/src/pages/index.astro @@ -0,0 +1,16 @@ +--- +const url = `${Astro.request.canonicalURL.origin}/company.json`; +const response = await fetch(url); +const data = await response.json(); +--- + + + + + Astro + + +

Astro

+
{JSON.stringify(data)}
+ + diff --git a/examples/non-html-pages/tsconfig.json b/examples/non-html-pages/tsconfig.json new file mode 100644 index 000000000..8e881cf9c --- /dev/null +++ b/examples/non-html-pages/tsconfig.json @@ -0,0 +1,5 @@ +{ + "compilerOptions": { + "moduleResolution": "node" + } +}