Unverified Commit 020dd242 authored by Kieran Gibb's avatar Kieran Gibb
Browse files

update README

parent bc31df3e
......@@ -13,13 +13,13 @@ Before you get started, ensure you have node `v11.12.0` or greater installed.
git clone http://gitlab.com/coboxcoop/cobox-server && cd cobox-server
# install dependencies
yarn
npm install
# start the app
yarn start
npm start
# optional - you can set an alternative port
yarn start --port 1234
npm start -- --port 1234
```
## API
......@@ -93,7 +93,7 @@ Swagger documentation is available at `/api-docs`.
To run a single instance and view the debugger, simply run
```
yarn dev:server
npm run dev:server
```
......@@ -101,10 +101,10 @@ To run two separate instances alongside eachother so you can get groups replicat
```
# open one terminal and run
yarn dev:server --port 1234 --mount ~/cobox/mount/one --storage ~/cobox/one
npm start dev:server -- --port 1234 --mount ~/cobox/mount/one --storage ~/cobox/one
# open a second terminal and run
yarn dev:server --port 2345 --mount ~/cobox/mount/two --storage ~/cobox/two
npm start dev:server -- --port 2345 --mount ~/cobox/mount/two --storage ~/cobox/two
```
# Contributing
......
Supports Markdown
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