https://github.com/ernest-rudnicki/preact-neutralino-typescript-starter

A boilerplate starter for building lightweight desktop applications
https://github.com/ernest-rudnicki/preact-neutralino-typescript-starter

boilerplate-template desktop-application neutralinojs preact typescript

Last synced: about 2 months ago
JSON representation

A boilerplate starter for building lightweight desktop applications

• Host: GitHub
• URL: https://github.com/ernest-rudnicki/preact-neutralino-typescript-starter
• Owner: ernest-rudnicki
• License: mit
• Archived: true
• Created: 2022-06-11T18:41:06.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-21T23:09:13.000Z (over 1 year ago)
• Last Synced: 2024-05-15T15:45:59.987Z (4 months ago)
• Topics: boilerplate-template, desktop-application, neutralinojs, preact, typescript
• Language: TypeScript
• Homepage:
• Size: 4.31 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-preact - Preact Neutralino TypeScript Starter - Starter project for building lightweight desktop applications with Preact and neutralino.js. (Uncategorized / Uncategorized)

README

        
# Preact Neutralino TypeScript Starter

A boilerplate starter for building lightweight desktop applications with Preact, Neutralino and TypeScript. The template uses SCSS and React Redux.

## Running the application in a development mode

```

// install neutralino cli globally

npm install -g @neutralinojs/neu

// inside the root folder

npm install

// inside the root folder of the repository

neu update

// install preact dependencies and do initial build

npm run setup

// run application in the development mode (after the preact project builds, you need to refresh the neutralino app)

npm run dev

// if the application does not refresh (happened for me on Mac with M1) run app parts separately

npm run dev:front

// in another terminal

npm run dev:app

```

## Useful commands

*   `npm run test:coverage`: runs tests to show the code coverage

*   `npm run test:watch`: runs tests in watch mode

*   `npm run dev:front`: runs only the Preact project in development mode

*   `npm run dev:app`: runs only the neutralino.js application in development mode

*   `npm run build-release`: builds the project for release