42 lines
1.1 KiB
Markdown
42 lines
1.1 KiB
Markdown
|
# Building Instructions
|
||
|
|
|
||
|
|
## Quick Start
|
||
|
|
|
||
|
|
1. **Install Dependencies**
|
||
|
|
```bash
|
||
|
|
npm install
|
||
|
|
```
|
||
|
|
|
||
|
|
2. **Test the Application**
|
||
|
|
```bash
|
||
|
|
npm start
|
||
|
|
```
|
||
|
|
This will launch the app in development mode.
|
||
|
|
|
||
|
|
3. **Build Windows Installer**
|
||
|
|
```bash
|
||
|
|
npm run build:win
|
||
|
|
```
|
||
|
|
This will create a Windows installer in the `dist` folder.
|
||
|
|
|
||
|
|
## Building for Distribution
|
||
|
|
|
||
|
|
After running `npm run build:win`, you'll find:
|
||
|
|
- An installer executable in the `dist` folder (e.g., `Recurring Checklist Setup 1.0.0.exe`)
|
||
|
|
- This installer can be copied to any Windows machine and run to install the application
|
||
|
|
|
||
|
|
## Notes
|
||
|
|
|
||
|
|
- The first build may take several minutes as it downloads Electron binaries
|
||
|
|
- Each Windows machine will have its own independent checklist data
|
||
|
|
- The app stores data locally using electron-store
|
||
|
|
- No internet connection required after installation
|
||
|
|
|
||
|
|
## Troubleshooting
|
||
|
|
|
||
|
|
If you encounter issues building:
|
||
|
|
1. Make sure Node.js is installed (version 14 or higher recommended)
|
||
|
|
2. Try deleting `node_modules` and running `npm install` again
|
||
|
|
3. On Windows, you may need to install build tools: `npm install --global windows-build-tools`
|
||
|
|
|