README.md 2.91 KB
Newer Older
Yannis Barlas's avatar
Yannis Barlas committed
1
# Editoria  
Yannis Barlas's avatar
Yannis Barlas committed
2 3 4 5 6

This is the Editoria monorepo.  

It consists of the main Editoria application, as well as the different [Pubsweet](https://gitlab.coko.foundation/pubsweet) components and helper libraries that the app is made of.  

7
This application is being developed by the [Coko Foundation](https://coko.foundation/) for the Editoria Community.  
8
For more information, visit the project's [website](https://editoria.pub/) or our [chat channel](https://mattermost.coko.foundation/coko/channels/editoria).  
Yannis Barlas's avatar
Yannis Barlas committed
9 10
For the editor that Editoria uses, see its related project [Wax](https://gitlab.coko.foundation/wax/wax).  

Alexandros Georgantas's avatar
Alexandros Georgantas committed
11
## Community Roadmap # 2 (DONE)
Yannis Barlas's avatar
Yannis Barlas committed
12 13
The current features on our list are the following:

Alexandros Georgantas's avatar
Alexandros Georgantas committed
14 15
| PROJECT       | DESCRIPTION                                                               | ISSUE # | IN PROGRESS | DONE |
|---------------|---------------------------------------------------------------------------|---------|-------------|------|
Alexandros Georgantas's avatar
Alexandros Georgantas committed
16 17 18
| EDITORIA      | Export Overhaul                                                           | #254 #307 #318 #319 #320 #321|             |     ✔   |
| WAX           | Wax Upgrades                                                              | #274 #281 #284 #285          |           |      ✔  |
| EDITORIA      | Paged.js enhancements                                                     | #322 #295 #261 #257 #256 |         |   ✔     |
Alexandros Georgantas's avatar
Alexandros Georgantas committed
19
| EDITORIA      | "Include in TOC" feature                                                  | #323    |                                  |   ✔     |
Alexandros Georgantas's avatar
Alexandros Georgantas committed
20
| EDITORIA      | "Save" button in Paged.js integration                                     | #288    |                                  |     ✔   |
Alexandros Georgantas's avatar
Alexandros Georgantas committed
21
| XSWEET        | Add Autonumbering to part components                                      | #260    |                                  |  ✔      |
Alexandros Georgantas's avatar
Alexandros Georgantas committed
22 23
| EDITORIA      | Replace INK with PubSweet Job Manager                                     | #255    |                                 |     ✔   |
| EDITORIA      | Add profile page per user                                                 | #293    |                              |    ✔    |
Alexandros Georgantas's avatar
Alexandros Georgantas committed
24
| EDITORIA      | Simpler navigation to/from components from within Wax                     | #276    |                                  |    ✔    |
25

Alexandros Georgantas's avatar
Alexandros Georgantas committed
26 27
## Editoria's flavors
Currently the application exists in three different flavours each one containing its' own customizations based on required functionalities  
Yannis Barlas's avatar
Yannis Barlas committed
28

Alexandros Georgantas's avatar
Alexandros Georgantas committed
29 30 31
* [Editoria Vanilla](https://gitlab.coko.foundation/editoria/editoria-vanilla)  
* [Editoria UCP](https://gitlab.coko.foundation/editoria/ucp)  
* [Editoria BookSprints](https://gitlab.coko.foundation/editoria/booksprints)  
Yannis Barlas's avatar
Yannis Barlas committed
32

Alexandros Georgantas's avatar
Alexandros Georgantas committed
33
The vanilla flavor includes all the features implemented by the development team and should be considered as the referesh application. 
34

Alexandros Georgantas's avatar
Alexandros Georgantas committed
35
## I want to try it  
Adam Hyde's avatar
Adam Hyde committed
36

Alexandros Georgantas's avatar
Alexandros Georgantas committed
37
In order to try the application, you should navigate and clone one of its' flavors and follow the getting up and running instructions
Adam Hyde's avatar
Adam Hyde committed
38 39 40



Alexandros Georgantas's avatar
Alexandros Georgantas committed
41