https://github.com/krypt0nn/electron-blank-app
Electron Blank Application
https://github.com/krypt0nn/electron-blank-app
Last synced: 10 months ago
JSON representation
Electron Blank Application
- Host: GitHub
- URL: https://github.com/krypt0nn/electron-blank-app
- Owner: krypt0nn
- License: gpl-3.0
- Created: 2021-09-14T09:03:49.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-10-13T15:18:57.000Z (over 4 years ago)
- Last Synced: 2025-01-06T06:43:36.964Z (over 1 year ago)
- Language: JavaScript
- Size: 86.9 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Electron Blank Application
This is the blank application for your electron project
## Requirements
To use Electron you must have installed node js. For windows it is available on its [official website](https://nodejs.org/en/), for linux you can download the `node` packet from your packet manager
## Installation
```sh
git clone https://github.com/krypt0nn/electron-blank-app ./my-app
cd my-app
npm i
```
`git clone` will download a blank bundle for your project and save it in the `./my-app` directory *(`my-app` folder in the current opened in the console directory)*
`cd my-app` will move you to this downloaded bundle
`npm i` will install requirements
## Set up
In the `package.json` you should change these parameters:
* name - your project name
* version
* description
* keywords - your project keywords
* author
## Development
Directory `src` stores your [TypeScript](https://typescriptlang.org) and [SASS](https://sass-lang.com) code. When you run `npm run dev` command in console - they will compile to the js and css files inside `public` directory
In the `public` stored information about your application - images it uses, html pages and something you want to use. Other directories will not be available in the compiled binaries
Default application page is `public/html/index.html`
To run your application - use `npm start` command. It will automatically run `npm run dev`
To build binaries run:
* For Windows: `npm run build:win`
* For Linux: `npm run build:linux`
All binaries will appear in the `dist` directory
Author: [Nikita Podvirnyy](https://vk.com/technomindlp)