diff --git a/README.md b/README.md index d85a4a8f7ba9a82da49863868d0aa6c6187ca9dd..fdc2ea287485c39fca48f195b5ab9d03842d421d 100644 --- a/README.md +++ b/README.md @@ -88,8 +88,8 @@ The sequence of commands for generating and running a sample app is as follows: ```bash pubsweet new my-app-name cd my-app-name -pubsweet setupdb (or npm run setupdb) -pubsweet start (or npm start) +pubsweet setupdb # (or npm run setupdb) +pubsweet start # (or npm start) ``` ## Using PubSweet CLI @@ -105,7 +105,7 @@ Usage: pubsweet [options] [command] Commands: new create and set up a new pubsweet app - start start a pubsweet app + start start a pubsweet app setupdb generate a database for a pubsweet app add add one or more components to a pubsweet app remove remove one or more components from a pubsweet app @@ -167,7 +167,7 @@ $ pubsweet setupdb --clobber info: Generating PubSweet app database at api/db/production info: Database already exists info: Overwriting existing database due to --clobber flag -info: Aetting up the database +info: Setting up the database question:><Admin username>< [...etc] ``` @@ -198,7 +198,7 @@ Forever is initialised to watch for changes in the config directory by default. ### Adding and removing components (`pubsweet add`, `pubsweet remove`) Components add pages, actions, and behaviors to pubsweet. There are many we have bundled by default, and you can create your own. To learn more about components, -[read the documentation](TODO!). +[read the documentation](https://pubsweet.org/docs/components). Run `add` or `remove` within your app directory, followed by one or more components, to add and remove components. These subcommands use `yarn` to add or remove the components and updates the configuration for your app accordingly. diff --git a/yarn.lock b/yarn.lock index ae1fb77a5480a6823fb3082ce1f7b7e688f9a80e..605812e41c49586f49ed34009c060850f9312f84 100644 --- a/yarn.lock +++ b/yarn.lock @@ -4,14 +4,14 @@ "@pubsweet/db-manager@git+https://gitlab.coko.foundation/yld/db-manager.git": version "0.0.2" - resolved "git+https://gitlab.coko.foundation/yld/db-manager.git#c1ad2f4a798ab772dceabacfc3a397ab76b0f173" + resolved "git+https://gitlab.coko.foundation/yld/db-manager.git#02b77946327504a1e201544d66f7c755e665ea29" dependencies: "@pubsweet/logger" "0.0.1" fs-extra "^4.0.2" isomorphic-fetch "^2.2.1" joi "^11.0.2" pouchdb "^6.3.4" - pubsweet-server "git+https://gitlab.coko.foundation/yld/pubsweet-server.git" + pubsweet-server "git+https://gitlab.coko.foundation/pubsweet/pubsweet-server.git" "@pubsweet/logger@0.0.1", "@pubsweet/logger@^0.0.1": version "0.0.1" @@ -344,6 +344,10 @@ authsome@0.0.4: version "0.0.4" resolved "https://registry.yarnpkg.com/authsome/-/authsome-0.0.4.tgz#7784887e6c17fdf126949c084cc3f543291dfb19" +authsome@0.0.6: + version "0.0.6" + resolved "https://registry.yarnpkg.com/authsome/-/authsome-0.0.6.tgz#505a2555a87e29f47af9a0d511bc553558073d72" + aws-sign2@~0.6.0: version "0.6.0" resolved "https://registry.yarnpkg.com/aws-sign2/-/aws-sign2-0.6.0.tgz#14342dd38dbcc94d0e5b87d763cd63612c0e794f" @@ -2349,7 +2353,7 @@ expect@^21.2.1: jest-message-util "^21.2.1" jest-regex-util "^21.2.0" -express@^4.14.0, express@^4.15.3: +express@^4.15.3, express@^4.16.1: version "4.16.1" resolved "https://registry.yarnpkg.com/express/-/express-4.16.1.tgz#6b33b560183c9b253b7b62144df33a4654ac9ed0" dependencies: @@ -4316,7 +4320,7 @@ moment@2.x.x: version "2.18.1" resolved "https://registry.yarnpkg.com/moment/-/moment-2.18.1.tgz#c36193dd3ce1c2eed2adb7c802dbbc77a81b1c0f" -morgan@^1.7.0: +morgan@^1.8.2: version "1.9.0" resolved "https://registry.yarnpkg.com/morgan/-/morgan-1.9.0.tgz#d01fa6c65859b76fcf31b3cb53a3821a311d8051" dependencies: @@ -5491,24 +5495,25 @@ pubsweet-component-users-manager@^0.1.6: version "0.1.6" resolved "https://registry.yarnpkg.com/pubsweet-component-users-manager/-/pubsweet-component-users-manager-0.1.6.tgz#0c7df8bfa3bddd5387422040c2d0ee908f7b0380" -pubsweet-server@^1.0.0-alpha.3, "pubsweet-server@git+https://gitlab.coko.foundation/yld/pubsweet-server.git": +pubsweet-server@^1.0.0-alpha.3, "pubsweet-server@git+https://gitlab.coko.foundation/pubsweet/pubsweet-server.git": version "1.0.0-alpha.3" - resolved "git+https://gitlab.coko.foundation/yld/pubsweet-server.git#728e00e5b98392bd95c23a0cf74c48473a4597ce" + resolved "git+https://gitlab.coko.foundation/pubsweet/pubsweet-server.git#4239a422cf12e70b300911da5d3bd9da72c123bf" dependencies: - authsome "0.0.4" + "@pubsweet/logger" "^0.0.1" + authsome "0.0.6" bcrypt "^1.0.2" body-parser "^1.15.2" colors "^1.1.2" config "^1.26.2" cookie-parser "^1.4.3" - express "^4.14.0" + express "^4.16.1" helmet "^3.8.1" http-status-codes "^1.0.6" joi "^10.0.6" jsonwebtoken "^7.1.7" lodash "^4.0.0" minimist "^1.2.0" - morgan "^1.7.0" + morgan "^1.8.2" multer "^1.1.0" passport "^0.3.2" passport-anonymous "^1.0.1" @@ -5537,7 +5542,7 @@ pubsweet-theme-plugin@^0.0.1: "pubsweet@git+https://gitlab.coko.foundation/yld/pubsweet-cli.git#refactor/db-manager": version "1.0.0-alpha.4" - resolved "git+https://gitlab.coko.foundation/yld/pubsweet-cli.git#cb4b2a653c207893c0cc0866ce41ad5300361b05" + resolved "git+https://gitlab.coko.foundation/yld/pubsweet-cli.git#2ff7a981bb5ebf49175281acebe2550829fac189" dependencies: "@pubsweet/db-manager" "git+https://gitlab.coko.foundation/yld/db-manager.git" "@pubsweet/logger" "^0.0.1"