an-anime-game-launcher/README.md
Observer KRypt0n_ 93a03a328a
Update README.md
2021-10-13 17:17:14 +02:00

1.6 KiB

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, for linux you can download the node packet from your packet manager

Installation

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 and SASS 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