README.md 2.08 KB
Newer Older
john's avatar
john committed
1
## Overview  
john's avatar
john committed
2

john's avatar
john committed
3
4
Editoria is a book production platform, built with [Pubsweet](https://gitlab.coko.foundation/pubsweet/) and [Substance](http://substance.io/).  
This application is being developed by the [Coko Foundation](https://coko.foundation/), for the [University of California Press](http://www.ucpress.edu/).
john's avatar
john committed
5
<br>
john's avatar
john committed
6

john's avatar
john committed
7
## Installation  
john's avatar
john committed
8

john's avatar
john committed
9
First you need to clone this repository on your machine.  
john's avatar
john committed
10
```git clone git@gitlab.coko.foundation:yannisbarlas/editoria.git```  
john's avatar
john committed
11
or the ```https``` equivalent:  
john's avatar
john committed
12
```git clone https://gitlab.coko.foundation/yannisbarlas/editoria.git```  
john's avatar
john committed
13
<br>
john's avatar
john committed
14

john's avatar
john committed
15
16
Once you have, navigate to the project's root directory.  
```cd editoria```  
john's avatar
john committed
17
<br>
john's avatar
john committed
18

john's avatar
john committed
19
This application is being developed with node 6 in mind.  
john's avatar
john committed
20
If you use nvm for managing different node versions, the project includes an ```.nvmrc``` file that you can take advantage of.  
john's avatar
john committed
21
<br>
john's avatar
john committed
22

john's avatar
john committed
23
24
Install the latest version of the ```pubsweet``` command line tool.  
```npm install --global pubsweet```  
john's avatar
john committed
25
<br>
john's avatar
john committed
26

john's avatar
john committed
27
28
Install the project's dependencies.  
```npm install```  
john's avatar
john committed
29
<br>
john's avatar
john committed
30

john's avatar
john committed
31
32
Create a database.  
```pubsweet setupdb ./```  
john's avatar
john committed
33

john's avatar
john committed
34
35
If you want to create a database for a development environment, simply pass the ```--dev``` option to the above command.  
```pubsweet setupdb ./ --dev```  
john's avatar
john committed
36

john's avatar
john committed
37
Follow the instructions, create the administrator user and name your book.  
john's avatar
john committed
38
<br>
john's avatar
john committed
39

john's avatar
john committed
40
41
42
43
Once that is done, you can run the app like so:  
```pubsweet run```  
Or if you want the development environment:  
```pubsweet run --dev```  
john's avatar
john committed
44
<br>
john's avatar
john committed
45

john's avatar
john committed
46
## Set up  
john's avatar
john committed
47

john's avatar
john committed
48
Log in as an administrator, and click on the "Teams" link in the navigation bar.  
john's avatar
john committed
49
<br>
john's avatar
john committed
50

john's avatar
john committed
51
52
53
54
Create 3 teams:  
- Name the first "Production Editor", give it a type of "Production Editor all" and choose your book from the Collection dropdown.  
- Name the second "Copy Editors", give it a type of "Copy Editor update" and choose your book from the Collection dropdown.  
- Name the third "Authors", give it a type of "Author update" and choose your book from the Collection dropdown.  
john's avatar
john committed
55
<br>
john's avatar
john committed
56

john's avatar
john committed
57
58
You can now assign different users to different roles.  
If a user is a production editor, the user can then also edit user roles for all other users.