Clone the repo and get set up with the dependencies:
git clone https://github.com/johanbrook/snickra.git
cd snickra
npm install
All commands:
npm run dev # Start app for developing
npm run server # Start dev server for hot reloading
npm run start # Start app in production
npm run lint # Lint whole app
npm run build # Build app into /dist
npm run package # Package app into /release for current platform
npm run package-all # Package app for all platforms
To start the app locally (in dev mode), we need a dev server for hot reloading, as well as running the actual Electron app. So run these commands in two separate shells:
npm run server
# Starts dev server on http://localhost:8080
npm run dev
# Starts Electron menu bar app
You will also be able to access Chrome DevTools when in dev mode. It'll open on app startup, but also with cmd+alt+I.
Lint the whole app (including .vue
files) with:
npm run lint
To generate a production build, run:
npm run build
This will generate dist/bundle.js
.
You can then start the app in production mode with:
npm start
Package the app for the current platform with:
npm run package
This generates a package into release
.
MIT © Johan Brook