Web-based and multi-devices e-book reader.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dist
src
.gitignore
CHANGELOG.md
CONTRIBUTING.md
Gemfile
Gemfile.lock
Gruntfile.js
LICENSE-GPL
LICENSE.md
README.fr.md
README.md
package.json

README.md

edsa

Web-based and multi-devices e-book reader.

Version française par ici

Objectives

The goal of this project is to provide a very capable and nice front-end only web-based ebook reader that can be embeded in a more complete ebook solution.

Usage

Grab a copy of the dist folder which contains all required assets.

Modify dist/index.html to suits your needs (ex. include your own text).

Instructions are not yet fully translated to english, we suggest you have a look at the demo and the text HTML format in index.html.

Development

If you want to modify EDSA or contribute to new feature, please read these steps first.

Your need NodeJS for development server and Ruby SASS for CSS.

The development server will watch for SASS source changes and regenerate the CSS files.

All sources are located in src and you may start the development server after installating Ruby SASS with bundle and NodesJS packages with npm :

gem install bundler # if you do not have bundler yet
bundle install
npm install

You may then run & open the development server :

grunt
open http://localhost:9002

Release version

Update package.json version and then use the grunt dist task to release a new version in dist folder. Make a commit to tag version release.

grunt dist
git commit -m "Release v1.0.0"
git tag v1.0.0
git push --tags

Credits & license

EDSA source is released under GNU General Public License Version 3. See LICENSE for details.

Project by René Audet, Codicille éditeur, Département des littératures, Université Laval, Hookt Studios, Heliom and other contributors.

Contributions are welcome, please read contributing guide first.