From ed5f91633d96436408c763bb96d2cc463cb7dc00 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Wed, 14 Jun 2017 21:37:49 +0200 Subject: [PATCH] Update readme/doc with new client port for dev --- README.md | 5 +++++ support/doc/client/code.md | 4 ++-- support/doc/server/code.md | 4 ++-- 3 files changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 391a9ec67..ff62f2123 100644 --- a/README.md +++ b/README.md @@ -189,10 +189,15 @@ To develop on the server side (server files are automatically compiled when we m $ npm run dev:server +The server (with the client) will listen on `localhost:9000`. + + To develop on the client side (client files are automatically compiled when we modify them): $ npm run dev:client +The API will listen on `localhost:9000` and the frontend on `localhost:3000` (with hot module replacement, you don't need to refresh the web browser). + **Username**: *root*
**Password**: *test* diff --git a/support/doc/client/code.md b/support/doc/client/code.md index bae53ffe5..89320a1b4 100644 --- a/support/doc/client/code.md +++ b/support/doc/client/code.md @@ -53,9 +53,9 @@ Uses [TSLint](https://palantir.github.io/tslint/) for TypeScript linting and [An ## Developing * Install [the dependencies](https://github.com/Chocobozzz/PeerTube#dependencies) - * Run `npm install` at the root directory to install all the dependencies + * Run `yarn install` at the root directory to install all the dependencies * Run PostgreSQL and create the database `peertube_dev`. - * Run `npm run dev:client` to compile the client, run the server and watch client files modifications. + * Run `npm run dev:client` to compile the client, run the server, watch client files modifications and reload modules on the fly (you don't need to refresh manually the web browser). The API listen on `localhost:9000` and the client on `localhost:3000`. In a Angular application, we create components that we put together. Each component is defined by an HTML structure, a TypeScript file and optionnaly a SASS file. If you are not familiar with Angular I recommend you to read the [quickstart guide](https://angular.io/docs/ts/latest/quickstart.html). diff --git a/support/doc/server/code.md b/support/doc/server/code.md index 13e592335..b941304ce 100644 --- a/support/doc/server/code.md +++ b/support/doc/server/code.md @@ -40,9 +40,9 @@ Uses [JavaScript Standard Style](http://standardjs.com/). ## Developing * Install [the dependencies](https://github.com/Chocobozzz/PeerTube#dependencies) - * Run `npm install` at the root directory to install all the dependencies + * Run `yarn install` at the root directory to install all the dependencies * Run PostgreSQL and create the database `peertube_dev`. - * Run `npm run dev:server` to compile the client, run the server and watch server files modifications. + * Run `npm run dev:server` to run the server, watch server files modifications and restart it automatically. The server (API + client) listen on `localhost:9000`. The `NODE_ENV=test` is set to speed up communications between pods (see [constants.ts](https://github.com/Chocobozzz/PeerTube/blob/master/server/initializers/constants.ts)).