diff --git a/README.md b/README.md index 7846e07..19d2fbc 100644 --- a/README.md +++ b/README.md @@ -1,102 +1,2 @@ -# electron-boilerplate - -A minimalistic boilerplate for [Electron runtime](http://electron.atom.io). Tested on Windows, macOS and Linux. - -This project contains only bare minimum of dependencies, to provide you with nice development environment. Doesn't impose on you any frontend technologies, so you can pick your favourite. - -# Quick start - -Make sure you have [Node.js](https://nodejs.org) installed, then type the following commands known to every Node developer... -``` -git clone https://github.com/szwacz/electron-boilerplate.git -cd electron-boilerplate -npm install -npm start -``` -...and you have a running desktop application on your screen. - -# Structure of the project - -The application consists of two main folders... - -`src` - files within this folder get transpiled or compiled (because Electron can't use them directly). - -`app` - contains all static assets which don't need any pre-processing. Put here images, CSSes, HTMLs, etc. - -The build process compiles the content of the `src` folder and puts it into the `app` folder, so after the build has finished, your `app` folder contains the full, runnable application. - -Treat `src` and `app` folders like two halves of one bigger thing. - -The drawback of this design is that `app` folder contains some files which should be git-ignored and some which shouldn't (see `.gitignore` file). But this two-folders split makes development builds much, much faster. - -# Development - -## Starting the app - -``` -npm start -``` - -## The build pipeline - -Build process uses [Webpack](https://webpack.js.org/). The entry-points are `src/background.js` and `src/app.js`. Webpack will follow all `import` statements starting from those files and compile code of the whole dependency tree into one `.js` file for each entry point. - -[Babel](http://babeljs.io/) is also utilised, but mainly for its great error messages. Electron under the hood runs latest Chromium, hence most of the new JavaScript features are already natively supported. - -## Environments - -Environmental variables are done in a bit different way (not via `process.env`). Env files are plain JSONs in `config` directory, and build process dynamically links one of them as an `env` module. You can import it wherever in code you need access to the environment. -```js -import env from "env"; -console.log(env.name); -``` - -## Upgrading Electron version - -To do so edit `package.json`: -```json -"devDependencies": { - "electron": "1.7.9" -} -``` -*Side note:* [Electron authors recommend](http://electron.atom.io/docs/tutorial/electron-versioning/) to use fixed version here. - -## Adding npm modules to your app - -Remember to respect the split between `dependencies` and `devDependencies` in `package.json` file. Your distributable app will contain modules listed in `dependencies` after running the release script. - -*Side note:* If the module you want to use in your app is a native one (not pure JavaScript but compiled binary) you should first run `npm install name_of_npm_module` and then `npm run postinstall` to rebuild the module for Electron. You need to do this once after you're first time installing the module. Later on, the postinstall script will fire automatically with every `npm install`. - -# Testing - -Run all tests: -``` -npm test -``` - -## Unit - -``` -npm run unit -``` -Using [electron-mocha](https://github.com/jprichardson/electron-mocha) test runner with the [Chai](http://chaijs.com/api/assert/) assertion library. You can put your spec files wherever you want within the `src` directory, just name them with the `.spec.js` extension. - -## End to end - -``` -npm run e2e -``` -Using [Mocha](https://mochajs.org/) and [Spectron](http://electron.atom.io/spectron/). This task will run all files in `e2e` directory with `.e2e.js` extension. - -# Making a release - -To package your app into an installer use command: -``` -npm run release -``` - -Once the packaging process finished, the `dist` directory will contain your distributable file. - -We use [electron-builder](https://github.com/electron-userland/electron-builder) to handle the packaging process. It has a lot of [customization options](https://www.electron.build/configuration/configuration), which you can declare under `"build"` key in `package.json`. - -You can package your app cross-platform from a single operating system, [electron-builder kind of supports this](https://www.electron.build/multi-platform-build), but there are limitations and asterisks. That's why this boilerplate doesn't do that by default. +# rats-search +BitTorrent ROTB search engine desktop version. You can use it on desktop now :)