Skip to content
Snippets Groups Projects
Commit 2d837f3a authored by john's avatar john
Browse files

readme: first version

parent bc8d9a84
No related branches found
No related tags found
No related merge requests found
## Overview
Editoria is a book production platform, built with Pubsweet and Substance.
This application is being developed by the Coko Foundation, for the University of California Press.
## Installation
First you need to clone this repository on your machine.
```git clone git@gitlab.coko.foundation:pubsweet/pubsweet.git```
or the ```https``` equivalent:
```https://gitlab.coko.foundation/yannisbarlas/editoria.git```
Once you have, navigate to the project's root directory.
```cd editoria```
This application is being developed with node 6 in mind.
If you use nvm for managing different node versions, the project includes an ```.nvmrc``` file that you can take advantage of.
Install the latest version of the ```pubsweet``` command line tool.
```npm install --global pubsweet```
Install the project's dependencies.
```npm install```
Create a database.
```pubsweet setupdb ./```
If you want to create a database for a development environment, simply pass the ```--dev``` option to the above command.
```pubsweet setupdb ./ --dev```
Follow the instructions, create the administrator user and name your book.
Once that is done, you can run the app like so:
```pubsweet run```
Or if you want the development environment:
```pubsweet run --dev```
## Set up
Log in as an administrator, and click on the "Teams" link in the navigation bar.
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.
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.
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment