Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prozilla-os/prozillaos-boilerplate
Boilerplate code for implementing the ProzillaOS library.
https://github.com/prozilla-os/prozillaos-boilerplate
boilerplate desktop-environment frontend prozilla-os react reactjs starter-kit typescript virtual-desktop web-os webtop
Last synced: 7 days ago
JSON representation
Boilerplate code for implementing the ProzillaOS library.
- Host: GitHub
- URL: https://github.com/prozilla-os/prozillaos-boilerplate
- Owner: prozilla-os
- Created: 2024-06-17T19:48:03.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-10-27T11:32:46.000Z (20 days ago)
- Last Synced: 2024-10-27T13:07:37.472Z (20 days ago)
- Topics: boilerplate, desktop-environment, frontend, prozilla-os, react, reactjs, starter-kit, typescript, virtual-desktop, web-os, webtop
- Language: TypeScript
- Homepage: https://os.prozilla.dev
- Size: 214 KB
- Stars: 2
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# ProzillaOS boilerplate
This project contains boilerplate code for working with the [`prozilla-os`][github] library. It uses React, Vite and TypeScript.
## Getting started
Requirements: **Node.js**
```sh
$ 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][localhost].
## 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][localhost].
- `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][localhost].
## Links
- [Website/demo][website]
- [Docs][docs]
- [GitHub][github]
- [npm][npm]
- [Ko-fi][ko-fi]
[website]: https://os.prozilla.dev/
[docs]: https://os.prozilla.dev/docs
[github]: https://github.com/prozilla-os/ProzillaOS/tree/convert-to-monorepo/packages/prozilla-os
[npm]: https://www.npmjs.com/package/prozilla-os
[ko-fi]: https://ko-fi.com/prozilla
[localhost]: http://localhost:3000/