ProzillaOS/docs/README.md

← Back

Documentation

Pages

• Features
• Configuration
• Design
• FAQ
• Roadmap
• Contributing

Overview

Quickstart

1. Clone this repository.
2. Run npm install to install dependencies.
3. Run npm start to start the web server and go to localhost:3000.

How to run

These are the scripts in logical order, that will be available when you have installed the dependencies. Note that certain scripts can be omitted by running another script. For more information about scripts #1, #2 and #3, check the officiel Vite documentation.

1. npm 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.

2. npm run build

   Compile project using TypeScript and bundle all files into the dist directory. This directory can be uploaded to a web server.

3. npm run serve

   Start web server with preview of build at localhost:8080. Can be useful for testing build before deploying.

4. npm run stage

   Run node program that stages the build and prepares it for deployment. Script will generate a sitemap, CNAME file, etc.

5. npm run deploy

   Run scripts #2 and #4, then execute deploy.sh, which deploys the staged build to GitHub Pages on branch called gh-pages.

Important

Check the "Deployment" section on the Configuration page, to see what configurations must be made before starting the staging or deployment process.

Note

After this deployment process, GitHub Pages will run its own build step to finalize the deployment, as seen in the Actions tab on GitHub. This usually takes less than a minute and once it's done, your deployment will be live.

Configuration

See docs/configuration for more information.

Project structure

• src directory

  Contains all code for the application, including HTML, CSS and TypeScript files. This directory makes use of a feature-based folder structure. Utility files are often separated into their own subdirectory, called _utils, inside of their respective directory.

• public directory

  Contains all static files like images, webfonts and vector graphics. Also includes the config and documents folders from where certain files are loaded into the virtual drive.

• docs directory

  You are here. This directory contains all documentation for this project.

• dist directory

  Contains the bundled build after the build process. This directory is not included in the GitHub repository.

• External files

  • Design file (Figma)
  • Task board (Notion)

Code style

Type	Case	Example	Based on
Folders	kebab-case	virtual-drive
.ts files	camelCase	virtualRoot.ts
.tsx files	PascalCase	Desktop.tsx	React component
.css files & static assets	kebab-case	global.css
Local .module.css files	PascalCase	Desktop.module.css	React component
Global .module.css files	kebab-case	utils.module.css
CSS class names	PascalCase	.WindowsView	React component
Variables	camelCase	const fooBar = true;
Global constant variables	MACRO_CASE	export const NAME = "ProzillaOS";
Classes	PascalCase	class WindowsManager { }
React components	PascalCase	export function WindowsView({ }) { }
Functions	camelCase	function focusWindow() { }
Types	PascalCase	type FooBar = boolean;