Bookle

Bookle is a A simple, friendly ebook manager

Whats Included?

• adm-zip
• glob
• rimraf
• electron
• electron-reload

Prerequisites

• node ^4.7.0
• npm ^2.0.0

Installation

Enter the following commands in your shell / terminal. If you're on Windows, you'll need to use Git BASH or similar.

# Clone this repository
git clone https://github.com/Adam-Collier/Bookle
# Go into the repository
cd Bookle
# Install dependencies
npm install
# Run the app
npm start

Note: If you want the app to reload on changes you need to make sure require('electron-reload')('**/*.{css,js,html}'); isnt commented out in main.js

Usage

Enter the following command to start the dev app:

$ npm start

When this command executes your electron app should automatically open and you can start to contribute! Please note when changing anything in main.js you will need to manually restart the app for any changes to take effect.

Project Structure

.
├── LICENSE.md
├── README.md
├── books
│   └── epub
├── fonts
│   ├── Lato-Bold.ttf
│   ├── Lato-Italic.ttf
│   ├── Lato-Light.ttf
│   ├── Lato-LightItalic.ttf
│   ├── Lato-Regular.ttf
│   ├── Lora-Bold.ttf
│   └── Lora-Regular.ttf
├── img
│   ├── add.svg
│   ├── close.svg
│   ├── list.svg
│   ├── read.svg
│   ├── read2.svg
│   └── upload.svg
├── index.html
├── js
│   ├── bookGenerate.js
│   ├── contextMenu.js
│   ├── index.js
│   ├── menu.js
│   ├── moveAndExtract.js
│   ├── openFile.js
│   └── saveEditedBook.js
├── main.css
├── main.js
├── node_modules
├── package.json
└── renderer.js

Included Scripts

$ npm run start           # Starts the app
$ npm run build           # Builds the app

Notes on electron

A basic Electron application needs just these files:

• package.json - Points to the app's main file and lists its details and dependencies.
• main.js - Starts the app and creates a browser window to render HTML. This is the app's main process.
• index.html - A web page to render. This is the app's renderer process.

Note: If you're using Linux Bash for Windows, see this guide or use node from the command prompt.

Resources for Learning Electron

• electron.atom.io/docs - all of Electron's documentation
• electron.atom.io/community/#boilerplates - sample starter apps created by the community
• electron/electron-quick-start - a very basic starter Electron app
• electron/simple-samples - small applications with ideas for taking them further
• electron/electron-api-demos - an Electron app that teaches you how to use Electron
• hokein/electron-sample-apps - small demo apps for the various Electron APIs