Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

πŸš€ Boilerplate code for implementing the ProzillaOS library.

Notifications You must be signed in to change notification settings

prozilla-os/ProzillaOS-boilerplate

Repository files navigation

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

AltStyle γ«γ‚ˆγ£γ¦ε€‰ζ›γ•γ‚ŒγŸγƒšγƒΌγ‚Έ (->γ‚ͺγƒͺγ‚ΈγƒŠγƒ«) /