ProzillaOS app boilerplate

This project contains boilerplate code for an app using the prozilla-os library. It uses React, Vite and TypeScript.

Getting started

Requirements: Node.js

git clone https://github.com/prozilla-os/ProzillaOS-app-boilerplate.git my-app
cd ./my-app
npm install
npm run start

You can test your app with a demo website that will be available at localhost:3000.

Project structure

This is an overview of the most important files and folders in this project.

.
├── /public  ———————————  Static assets (favicons, images, fonts, ...)
│
├── /src
│   ├── /components  ———————  React components
│   │   ├── /demo  ——————————————  Main component of demo website to test app with
│   │   └── MyApp.tsx  ——————————  Main component of your app
│   ├── /config/demo  ——————  Config files for demo website
│   ├── /types  ————————————  TypeScript types
│   └── main.ts  ———————————  Main entry point that defines your app, including metadata
│
├── eslint.config.js  ——  Linting configurations
├── index.html  ————————  HTML file for demo websiet
├── package.json  ——————  Project metadata and dependencies
├── README.md  —————————  You are here
├── tsconfig.json  —————  TypeScript configurations
└── vite.config.ts  ————  Vite configurations

Scripts

• npm run start - Starts the Vite development server at localhost:3000.
• npm run build - Compiles the project using TypeScript and bundles all files into the dist folder.
• npm run update - Creates a new version.
• npm run release - Publishes the latest version to npm.

Links

• ProzillaOS
• Docs
• GitHub
• npm
• Ko-fi