diff --git a/README.md b/README.md index 1748d5c5027a4c07fd6abeb518c117619b66c703..7099c5b1b78c887d30e06463b54698871abdc115 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ -Note: xpub is still _very_ new. This repository contains an initial set of components but is not yet ready for use. ## xPub-faraday @@ -7,13 +6,11 @@ An MVP implementation of the first design sessions which allows a user to go thr ## Roadmap The major tasks we're planning to work on are the following: -* Implement a future-proof theming setup. (#88) -* Let users go through multiple rounds of review. (#50) -* Implement roles and permissions. (#58) -* Change the data model to account for the changes that have occured in `pubsweet-server`, as well as to make it easily portable to Postgres in the future. (#67) -* Merge xpub's authentication, routing and navigation with pubsweet's. (#55 #89 #57) - - +* Implement a future-proof theming setup. +* Let users go through multiple rounds of review. +* Implement roles and permissions. +* Change the data model to account for the changes that have occured in `pubsweet-server`, as well as to make it easily portable to Postgres in the future. +* Merge xpub's authentication, routing and navigation with pubsweet's. You can follow more fine-grained lists of things that we're working on * [Faraday](https://gitlab.coko.foundation/xpub/xpub-faraday/boards) for tasks related to `xpub-faraday` and @@ -21,7 +18,7 @@ You can follow more fine-grained lists of things that we're working on ## Installing -In the root directory, run `yarn` to install all the dependencies. +In the root directory, run `yarn` to install all the dependencies. ## Configuration Add the following values to `packages/xpub-collabra/config/local-development.json` @@ -34,40 +31,18 @@ Add the following values to `packages/xpub-collabra/config/local-development.jso } ``` +xPub-faraday is using external services as AWS, MTS-FTP, Publons, ORCID. In order to run the app locally a `.env` file is mandatory with keys and settings for each service. + +Contact us at technology@hindawi.com for help getting setup. + ## Running the app -1. `cd packages/xpub-faraday` -2. The first time you run the app, initialize the database with `yarn run setupdb` (press Enter when asked for a collection title, to skip that step). +1. Open Docker engine +2. `cd packages/xpub-faraday` +3. start services with `yarn services` +3. The first time you run the app, initialize the database with `yarn run setupdb` (press Enter when asked for a collection title, to skip that step). 3. `yarn start` -## Email Flow - -1. When a **new manuscript is submitted**, notify: - * the `Editor in Chief` - * all the manuscript `Authors`:exclamation: -1. When the **Handling Editor ACCEPTS or DECLINES an assignment**, notify the `Editor in Chief` -2. When a **Reviewer ACCEPTS an invitation**, notify: - * the `Handling Editor` - * the `Reviewer` with a "thank you" message -2. When a **Reviewer DECLINES an invitation**, notify the `Handling Editor` -3. When a **Reviewer submits a REVIEW REPORT**, notify the `Handling Editor` -4. When the **Handling Editor makes ANY RECOMMENDATION**, notify:S - * the `Accepting Reviewers`, informing them that their _report_ is no longer necessary - * the `Pending Reviewers`, informing them that their _answer_ is no longer necessary - * the `Editor in Chief` -1. When the **Handling Editor requests a REVISION**, notify: - * the `Submitting Author` -1. When the **Author submits a MAJOR REVISION**, notify: - * the `Handling Editor` - * the `Submitted Report Reviewers` -1. When the **Author submits a MINOR REVISION**, notify: - * the `Handling Editor` -1. When the **Editor in Chief CONFIRMS A RECOMMENDATION to reject or to publish a manuscript**, notify: - * the `Handling Editor` - * the `Submitted Report Reviewers` - * all the manuscript `Authors` -1. When the **Editor in Chief RETURNS a manuscript**, notify: - * the `Handling Editor` ## Community