Skip to content

Commit

Permalink
#10 Update README according to new scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
SinusStudios committed Apr 13, 2020
1 parent 3ccca45 commit 6aa0b01
Showing 1 changed file with 6 additions and 27 deletions.
33 changes: 6 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,41 +38,20 @@ What you need:

- [NodeJS](https://nodejs.org/) (comes with NPM)

### Controller

Setup:

```sh
cd controller
npm install
```

Run for development: `npm run start` (from `/controller/`) or `npm run controller` (from repository root)

Build for production: `npm run build` (from `/controller/`)

### Host

Setup:

```sh
cd host
npm install
npm run install-all
```

Run for development: `ts-node main.ts` (from `/host/`, requires `npm i -g ts-node`)
**Not the same as `npm install`!**

Build for production: `pkg main.ts` (from `/host/`, requires `npm i -g pkg`)
This command runs `npm install` for client, controller and host.

### Client (script file for scoreboards)

Setup:
Build all:

```sh
cd client
npm install
npm run build
```

Run for development: `parcel index.html` (from `/client/`, requires `npm i -g parcel`)

Build for production: `parcel build index.html` (from `/client/`, requires `npm i -g parcel`)
To run or build invididual parts, `cd` into the folder and run `npm start` or `npm run build`.

0 comments on commit 6aa0b01

Please sign in to comment.