ProzillaOS boilerplate

This project contains boilerplate code for working with the prozilla-os library. It uses React, Vite and TypeScript.

Getting started

Requirements: Node.js

$ git clone https://github.com/prozilla-os/ProzillaOS-boilerplate.git prozilla-os
$ cd ./prozilla-os
$ npm install
$ npm run dev

Your website 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
│   │   └── App.tsx  ———————————  App component that renders the ProzillaOS component with optional configs
│   ├── /config  ———————————  Config files for ProzillaOS
│   ├── /styles  ———————————  Stylesheets
│   │   └── index.css  —————————  Global stylesheet
│   ├── /types  ————————————  TypeScript types
│   └── index.tsx  —————————  Main entry point that renders the app
│
├── eslint.config.js  ——  Linting configurations
├── index.html  ————————  HTML file containing metadata and a link to the main script
├── package.json  ——————  Project metadata and dependencies
├── README.md  —————————  You are here
├── tsconfig.json  —————  TypeScript configurations
└── vite.config.ts  ————  Vite configurations

Scripts

• npm run dev - 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 lint - Runs a linter on all .ts and .tsx files.
• npm run preview - Previews the build in the dist folder on a local web server at localhost:3000.

Links

• Website/demo
• Docs
• GitHub
• npm
• Ko-fi