https://github.com/CyberAula/ediphy
Ediphy. E-learning authoring tool using React + Redux + Webpack
https://github.com/CyberAula/ediphy
authoring-tool e-learning react
Last synced: 11 months ago
JSON representation
Ediphy. E-learning authoring tool using React + Redux + Webpack
- Host: GitHub
- URL: https://github.com/CyberAula/ediphy
- Owner: CyberAula
- Created: 2016-10-24T10:52:15.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-03-28T11:51:11.000Z (about 2 years ago)
- Last Synced: 2024-08-17T08:07:28.195Z (almost 2 years ago)
- Topics: authoring-tool, e-learning, react
- Language: JavaScript
- Homepage: https://ging.github.io/ediphy
- Size: 564 MB
- Stars: 50
- Watchers: 16
- Forks: 13
- Open Issues: 50
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Ediphy Editor
[](https://app.codacy.com/app/sonsoleslp/ediphy?utm_source=github.com&utm_medium=referral&utm_content=ging/ediphy&utm_campaign=Badge_Grade_Dashboard)
[](https://travis-ci.org/ging/ediphy)
**Ediphy Editor** is an open source e-learning authoring tool to create different types of resources (web documents, slides and more coming up soon).
This software is written in Javascript (ES6), making use of React and Redux.
## Installation and manual
Visit our wiki to see all the available Ediphy Editor instructions.
In order to install this project you will need `node` 8.x.x (latest), `yarn` and git.
First clone the repo and then install the dependencies like so:
```bash
git clone https://github.com/ging/ediphy.git
cd ediphy
yarn
yarn upgrade
```
Once everything is installed, you can run the application with the following line:
```bash
yarn start
```
## Code quality and documentation
We use ESDoc in order to generate our documentation.
To regenerate it after a change you need to run:
```bash
yarn run doc
```
We also make use of ESLint in order to guarantee a certain code quality. With the following line you will fix all the formatting errors and view those that can't be automatically fixed:
```bash
yarn run eslint
```
## Discussion and contribution
Feel free to raise an issue or send us a message at github.
## Copyright
Copyright 2016 Universidad Politécnica de Madrid
Ediphy is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
Ediphy Editor is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with Ediphy Editor. If not, see http://www.gnu.org/licenses.