README.md 5.31 KB
Newer Older
Richard Smith-Unna's avatar
Richard Smith-Unna committed
1
<div width="100%" align="center">
Richard Smith-Unna's avatar
Richard Smith-Unna committed
2
  <img src="https://gitlab.coko.foundation/pubsweet/pubsweet/raw/master/assets/rgb-medium.jpg" width="300" />
Richard Smith-Unna's avatar
Richard Smith-Unna committed
3
  <h2>The open toolkit for building publishing workflows</h2>
Richard Smith-Unna's avatar
Richard Smith-Unna committed
4
</div>
Jure's avatar
Jure committed
5

6 7 8
| ![PubSweet home](https://img.shields.io/badge/PubSweet-home-51c1bc.svg?style=flat&colorA=84509d) [![MIT license](https://img.shields.io/badge/license-MIT-e51879.svg)](https://gitlab.coko.foundation/pubsweet/pubsweet/raw/master/LICENSE) [![mattermost](https://img.shields.io/badge/mattermost_chat-coko%2Fpubsweet-blue.svg)](https://mattermost.coko.foundation/coko/channels/pubsweet) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) |
| :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |

Jure's avatar
Jure committed
9

Richard Smith-Unna's avatar
Richard Smith-Unna committed
10 11 12 13
# Contents

<!-- TOC depthFrom:1 depthTo:6 withLinks:1 updateOnSave:0 orderedList:0 -->

14 15 16 17
* [Overview](#overview) - [PubSweet packages](#pubsweet-packages)
* [Getting started](#getting-started)
* [Support](#support)
* [Credits](#credits)
Richard Smith-Unna's avatar
Richard Smith-Unna committed
18 19 20

<!-- /TOC -->

Richard Smith-Unna's avatar
Richard Smith-Unna committed
21
# Overview
Jure's avatar
Jure committed
22

Richard Smith-Unna's avatar
Richard Smith-Unna committed
23
**PubSweet** allows you to build state-of-the-art publishing platforms.
Jure's avatar
Jure committed
24

Richard Smith-Unna's avatar
Richard Smith-Unna committed
25
It's a modular and flexible framework consisting of a **server** and **client** that work together, **components** that can modify or extend the functionality of the server and/or client, and a **command-line tool** that helps manage PubSweet apps.
Jure's avatar
Jure committed
26

Jure's avatar
Jure committed
27
## PubSweet packages (managed with Lerna)
Jure's avatar
Jure committed
28

29 30 31 32 33 34 35 36 37
| package                                                                                                                                                                                                              | description                                                           |
| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------- |
| [![pubsweet-server](https://img.shields.io/badge/PubSweet-server-51c1bc.svg?style=flat&colorA=84509d) pubsweet-server](https://gitlab.coko.foundation/pubsweet/pubsweet/tree/master/packages/server)                 | an extensible RESTful API that runs on the server                     |
| [![pubsweet-client](https://img.shields.io/badge/PubSweet-client-51c1bc.svg?style=flat&colorA=84509d) pubsweet-client](https://gitlab.coko.foundation/pubsweet/pubsweet/tree/master/packages/client)                 | an extensible frontend app that runs in the browser                   |
| [![pubsweet-components](https://img.shields.io/badge/PubSweet-components-51c1bc.svg?style=flat&colorA=84509d) pubsweet-components](https://gitlab.coko.foundation/pubsweet/pubsweet/tree/master/packages/components) | components for server and/or client                                   |
| [![pubsweet-cli](https://img.shields.io/badge/PubSweet-CLI-51c1bc.svg?style=flat&colorA=84509d) pubsweet cli](https://gitlab.coko.foundation/pubsweet/pubsweet/tree/master/packages/cli)                             | a suite of command-line tools for building and managing your platform |
| [pubsweet-theme-plugin](https://gitlab.coko.foundation/pubsweet/pubsweet/tree/master/packages/theme-plugin)                                                                                                          | webpack plugin for theme support in PubSweet                          |
| [@pubsweet/logger](https://gitlab.coko.foundation/pubsweet/pubsweet/tree/master/packages/logger)                                                                                                                     | logging utility                                                       |
| [@pubsweet/db-manager](https://gitlab.coko.foundation/pubsweet/pubsweet/tree/master/packages/db-manager)                                                                                                             | utility for managing PubSweet databases                               |
Jure's avatar
Jure committed
38

Richard Smith-Unna's avatar
Richard Smith-Unna committed
39
# Getting started
Jure's avatar
Jure committed
40

41
The entry-point into PubSweet is the `pubsweet` command-line tool: [pubsweet-cli](https://gitlab.coko.foundation/pubsweet/pubsweet/tree/master/packages/cli).
Jure's avatar
Jure committed
42

Richard Smith-Unna's avatar
Richard Smith-Unna committed
43
# Support
Jure's avatar
Jure committed
44

45
* **If you have a general query about PubSweet**, or want to discuss anything with us, come and [chat to us in our Mattermost channel](https://mattermost.coko.foundation/coko/channels/pubsweet).
Jure's avatar
Jure committed
46

47
* **Bug reports and feature requests** belong in the issues of this monorepo.
Richard Smith-Unna's avatar
Richard Smith-Unna committed
48

Richard Smith-Unna's avatar
Richard Smith-Unna committed
49 50
# Projects using PubSweet

51 52
* [Editoria](https://gitlab.coko.foundation/editoria/editoria) - a book production platform built for University of California Press
* [Xpub](https://gitlab.coko.foundation/xpub/xpub) - a journal publishing platform
Richard Smith-Unna's avatar
Richard Smith-Unna committed
53

Richard Smith-Unna's avatar
Richard Smith-Unna committed
54 55 56 57
# Credits

PubSweet is part of the [Collaborative Knowledge Foundation](https://coko.foundation) family.

Richard Smith-Unna's avatar
Richard Smith-Unna committed
58
<a href="https://coko.foundation"><img src="https://gitlab.coko.foundation/pubsweet/pubsweet/raw/master/assets/COKO_logo.jpg" width="300" /></a>