Skip to content

starfactorypixel/Launcher

Repository files navigation

Pixel Launcher

Launcher for Pixel OS.

Installing

Preliminary requirements:

Installing dependencies:

npm i

Building

Build application main (entry point):

npm run build:main

Build application view (react app):

npm run build:view
Build application installer
npm run build:win
npm run build:linux
npm run build:linux-x64

Build all:

npm run build

ESLint & Prettier

Linter check:

npm run lint

Linter fix:

npm run lint:fix

Format code (with Prettier):

npm run format

Starting

Starting in development mode:

npm start

Starting in production mode:

npm start:prod

File structure

List of folders:

  • src - Application code.
  • view - Application view (frontend).
    • src - Code.
    • public - Static assets for server.
  • assets - Application assets (Icons and others).
  • build - Built application installer (Windows (.exe) or Linux (.deb)).
  • dist - Compiled application code.
  • node_modules - Node.js dependencies.

Environment variables

List of variables:

  • NODE_ENV - Application mode.
  • DEV_PORT - Dev Server port. Default: 15070.
  • DEV_TOOLS - Usage DevTools if 1. Default: 0.
  • DEV_TOOLS_EXTENSIONS - Usage DevTools extensions (React Developer Tools) if 1. Default: 0.
  • DOCKER_BUILD - Usage Docker in build. Default: 0.
  • WEBPACK_DEV - Webpack middleware starting if 1. Default: 0.

Dotenv support is present!

Stack

License

GPL-3.0