| .. | ||
| public | ||
| scripts | ||
| src | ||
| index.html | ||
| package.json | ||
| README.md | ||
| tsconfig.build.json | ||
| tsconfig.json | ||
| vite.config.ts | ||
About
@prozilla-os/demo is a React Vite website that demonstrates the features of ProzillaOS.
Scripts
| Script | Description |
|---|---|
pnpm run start |
Start Vite dev server at localhost:3000. Changes to module will dynamically be hot-reloaded, so normally there is no need for hard-refreshes. VSCode is configured to run this script whenever the project is opened. |
pnpm run build |
Compile project using TypeScript and bundle all files into the dist directory, or the directory specified in config file. This directory can be uploaded to a web server. |
pnpm run preview |
Start web server with preview of build at localhost:8080. Can be useful for validating build before deploying. |
pnpm run stage |
Execute stage.ts, which stages the build and prepares it for deployment. Script will generate a sitemap, robots.txt and all other necessary files. |
pnpm run deploy |
Run pnpm run build && pnpm run stage, then execute deploy.ts, which uploads the staged build to GitHub Pages on branch called gh-pages. This should then trigger a GitHub Action that deploys the build to production. |
pnpm run fetch |
Fetch the repository tree using GitHub's API and store it as a JSON file that will be used to populate the virtual drive. More information can be found on the virtual drive page. |