Commit 252105d9 authored by Tamlyn Rhodes's avatar Tamlyn Rhodes

docs: clarify startup instructions

parent 26787492
Pipeline #5014 passed with stages
in 6 minutes and 39 seconds
......@@ -5,13 +5,16 @@ Welcome to the skeleton application!
## Quickstart
pubsweet setupdb # or npm run setupdb
pubsweet start # or npm start
This will use Docker to get you up and running quickly. See `pubsweet` docs for
troubleshooting and other ways to start the app.
## Customising the skeleton application
* Change `name` in `package.json` to your desired name
* Modify app config in the `/config` directory and webpack config in `/webpack`.
* Run `pubsweet add <components>` or `pubsweet remove <components>` to add or remove components.
* Run `pubsweet add <components>` or `pubsweet remove <components>` to add or
remove components.
* Rewrite this README!
module.exports = {
'pubsweet-server': {},
'pubsweet-server': {
// this must be provided
baseUrl: undefined,
......@@ -2,8 +2,8 @@ version: '2.1'
image: node:8
command: sh -c "yarn && yarn start:server"
image: pubsweet/pubsweet:base
command: sh -c "yarn && yarn server"
- ${PORT:-3000}:3000
......@@ -20,4 +20,4 @@ services:
- ./scripts/test.sql:/docker-entrypoint-initdb.d/test.sql
\ No newline at end of file
- ./scripts/test.sql:/docker-entrypoint-initdb.d/test.sql
......@@ -83,7 +83,7 @@
"scripts": {
"lint": "eslint --ext js,jsx app config test webpack",
"start": "docker-compose up",
"start:server": "pubsweet server",
"server": "pubsweet server",
"start:services": "docker-compose up db",
"setupdb": "pubsweet setupdb",
"create:collection": "node scripts/add-collection.js",
Markdown is supported
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