Skip to content
Snippets Groups Projects
user avatar
authored
Forked from pubsweet / pubsweet
Source project has a limited visibility.

The open toolkit for building publishing workflows

MIT license mattermost Commitizen friendly

Contents

Overview

PubSweet allows you to build state-of-the-art publishing platforms.

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.

PubSweet packages (managed with Lerna)

package description
pubsweet-server pubsweet-server an extensible GraphQL API (+ custom REST endpoints needed for things like OAuth) that runs on the server
pubsweet-client pubsweet-client an extensible frontend React app that runs in the browser
pubsweet-components pubsweet-components components for server and/or client
pubsweet-cli pubsweet cli a suite of command-line tools for building and managing your platform
@pubsweet/logger logging utility
@pubsweet/db-manager utility for managing PubSweet databases

Wiki

The PubSweet Wiki contains all of the documentation for the PubSweet framework.

The wiki answers most of the common questions around:

  • Setting up your local environment
  • Documentation of PubSweet components
  • Using PubSweet components
  • The PubSweet data model
  • Technical terms
  • Contributing

Additionally, we've collaboratively written (using Editoria, a PubSweet-based app), a book about PubSweet.

Support

  • If you have a general query about PubSweet, or want to discuss anything with us, come and chat to us in our Mattermost channel.

  • Bug reports and feature requests belong in the issues of this monorepo.

Projects using PubSweet

  • Editoria - a book production platform built for University of California Press
  • Xpub - Collabra, a journal publishing platform
  • elife-xpub - A journal publishing platform in collaboration with eLife
  • Faraday - A journal publishing platform in collaboration with Hindawi
  • Micropubs - A micropublications platform in collaboration with Wormbase

Credits

PubSweet is part of the Collaborative Knowledge Foundation family.