Skip to content
develop
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
app
 
 
 
 
e2e
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

PREreview 2

PREreview logo

API stability MIT license

NOTE: this project is under very active development and is not currently accepting contributions. Thanks for taking an interest 😊. Feel free to star/watch the repo and we'll remove this notice once we have processes and documentation in place to allow people to collaborate productively.

Join our PREreview Slack Channel

[TODO] Developer quick links

  • Design
  • Roadmap
  • Project-level issue tracking
  • Development milestones and issue tracker
  • COKO PREreview development mattermost channel
  • Gitter channel

Developer instructions

Things to install

  • yarn
  • docker

Things to be aware of

  • We use commitlint, so your commit messages must:
    • have a 'type', e.g. chore: upgrade dependencies or fix: nothing works (closes #12)
    • be all lowercase
  • We use stylelint with the recommended rules
  • We use eslint and inherit rules from the pubsweet project's configuration

Install dependencies

yarn

Setup a development database

To create a development database:

docker-compose up -d
yarn setupdb

You can also populate the database with some demo data:

yarn seed:demo

Run development environment

Make sure docker-compose is running the services either in another terminal or backgrounded with -d, then:

yarn server

Interact with the app

  1. Visit http://localhost:3000
  2. Login as admin:admin
  3. Enjoy

About

PREreview - Post, Read and Engage with preprint reviews (open source v2 in development)

Topics

Resources

Releases

No releases published

Packages

No packages published

Languages