git

The Electric Book Manager

This is work in progress. The Electric Book Manager is a web-based interface for managing the Electric Book workflow. It will enable non-technical publishing teams to edit book content, review contributions, and output PDF, web- and epub-ready files. See the features currently in development here.

electricbook GUI tool

To run electricbook GUI tool locally, you need to do the following:

Build the bin/electricbook binary:

./build.sh

Make a copy of ./electricbook.yml to ./electricbook-0.yml and configure the following parameters:

github:
  client: "-clientID from github oauth application configuration-"
  secret: "-secret from github oauth application configuration-"

Get a personal access token from GitHub (Settings > Developer Settings > Personal access tokens. At "Select scopes", you currently only need to select repo.

Place the token and your GitHub username in ~/.ebw.yml:

users:
    - token:
    - name:

Running the app

Start the local electricbook server:

bin/electricbook -logtostderr web

You should then have the UI running on http://localhost:16101/.

Run npm install to install the rest of the dependencies. Generate the production-ready CSS by running

gulp scss

If you're going to make changes to the SCSS or JS in the src directory, install dtemplate, then run gulp watch to watch for changes.

ebw CLI tool

Basic Settings

ebw -u [alias]

Sets the user (as defined by name in config file) for this session

ebw -config [filename]

Loads the ebw configuration from [filename]

CLI related commands

ebw cli users

Lists all the users configured for the CLI (based on config file)

ebw cli user

Find out which user we are currently working as. You can force this with -u, or ebw will find it from the current repo-owner on github of the working directory of the currently checked out repo.

Github related commands

ebw github username

Displays the github username of the current user

ebw github repos

Lists all the repos owned by the current user on github

ebw github delete-repo [reponame]

Deletes the named repo from your github account. USE WITH EXTREME CAUTION.

Book Related Commands

ebw book new [name-of-book-repo]

Creates a new book with the given repo name in your github account, and checks it out into your local directory.

ebw book contribute [name-of-user]/[name-of-repo]

Creates a copy of the given book so that you can contribute to the book (and does a clone: copies the files to the current working directory)

ebw book clone [name-of-book-repo]

Same as 'git clone' with appropriate github settings, creating a local copy of the repo from your github account.

ebw book pull-request [message]

Sends a pull-request on the current directory to ? origin-master?

ebw book pull

ebw book push

Using friendly terminology

In the UI, we want to avoid using technical terms like commit and repo. Here's a rough guide to what we use:

Deployment

See README-deploy.md