https://github.com/benjammin4dayz/neu-react-vite
A template to kickstart your Neutralino.js apps with React, Vite, and optionally TypeScript!
https://github.com/benjammin4dayz/neu-react-vite
boilerplate hot-module-replacement minimal neutralino neutralinojs reactjs template vite
Last synced: 6 months ago
JSON representation
A template to kickstart your Neutralino.js apps with React, Vite, and optionally TypeScript!
- Host: GitHub
- URL: https://github.com/benjammin4dayz/neu-react-vite
- Owner: benjammin4dayz
- License: mit
- Created: 2024-04-05T13:45:07.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-28T12:11:16.000Z (about 1 year ago)
- Last Synced: 2024-10-28T15:21:48.496Z (about 1 year ago)
- Topics: boilerplate, hot-module-replacement, minimal, neutralino, neutralinojs, reactjs, template, vite
- Language: JavaScript
- Homepage:
- Size: 269 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
neu-react-vite
A minimal template for building Neutralino.js apps using React and Vite.
## About
This Neutralino app template features HMR _(Hot Module Replacement)_ and uses SWC _(Speedy Web Compiler)_. It can be converted to TypeScript with a single command!
### Demo
Start developing your app in _less than 30 seconds!_
## Getting Started
This template abstracts the setup process by using the [`neu` CLI][neu-cli] under the hood.
### Prerequisites
- Node.js
- npm
### Installation
1. Create a new app with `neu create`
```bash
npx @neutralinojs/neu create myapp --template benjammin4dayz/neu-react-vite
cd myapp
```
Alternative Method (Expand)
1. Clone the repo
```bash
git clone --depth=1 https://github.com/benjammin4dayz/neu-react-vite.git
cd neu-react-vite
```
2. Install dependencies
```bash
npm run setup
```
### Configuration
- Convert this template to TypeScript
```bash
node .ts-convert
```
## Usage
- Local Development
```bash
# Develop
npm start
# Build
npm run build
# Package
npm run build:release
```
[View scripts][npm-scripts]
- GitHub Actions
```bash
# Build and draft a release on GitHub:
git tag
git push origin
```
[View workflow][workflow-file]
## Troubleshooting
Before proceeding, try refreshing the page inside your app with `F5`, `CTRL + R`, or by right-clicking and selecting `Refresh`.
### Blank screen with no errors during development
Try pasting this snippet in the DevTools console tab:
```js
window.location.href = 'http://localhost:3000';
```
[neu-cli]: https://neutralino.js.org/docs/cli/neu-cli
[neu-conf]: ./neutralino.config.json
[npm-scripts]: ./package.json
[workflow-file]: .github/workflows/create-neutralinojs-app.yml