Note: This project has only being tested on a linux machine and it's working perfectly. This is open source so feel free to contribute. :)
- Electron 8+ - install globally with
npm i -g electron@latest
- Gridsome - install
npm install --global @gridsome/cli
- Typescript (Optional) - install globally with
npm i -g typescript
If you have the Gridsome CLI installed, simply run:
gridsome create <YOUR_PROJECT_NAME> https://github.com/DNature/gridsome-electron-boilerplate
After creating your project, skip to the second step and continue till the end.
If you done have Gridsome CLI then follow these steps.
- Clone the project:
git clone https://github.com/DNature/gridsome-electron-boilerplate.git <YOUR_PROJECT_NAME>
# if <YOUR_PROJECT_NAME> is not specified then it defaults to gridsome-electron-boilerplate
-
Move to the appropriate directory:
cd <YOUR_PROJECT_NAME>.
-
Run
yarn
ornpm install
to install all the necessary dependencies. -
Run
npm run grant
oryarn grant
to makestartServer.sh
executable. -
Run
yarn start
ornpm run start
to start the server. -
enter your environment.
prod
orproduction
for production environment.dev
ordevelopment
for development environment.
Now you're ready to rumble! 🤓