Update readme/doc with new client port for dev
authorChocobozzz <florian.bigard@gmail.com>
Wed, 14 Jun 2017 19:37:49 +0000 (21:37 +0200)
committerChocobozzz <florian.bigard@gmail.com>
Wed, 14 Jun 2017 19:37:49 +0000 (21:37 +0200)
README.md
support/doc/client/code.md
support/doc/server/code.md

index 391a9ec67313cbb14e2f8e4f4387285300bbbb2b..ff62f21238dc9b96eca29e7ede913602cbbad2ea 100644 (file)
--- 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* <br/>
 **Password**: *test*
 
index bae53ffe5171807ca8bbc9a84cd03e4e157a062c..89320a1b4768c2cd41e0466e3abf8ac907ff96a5 100644 (file)
@@ -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).
index 13e5923351c3eef60f23d2414bec6d5d9f21fba1..b941304ce7aa6c2a4ceebcc0b96a7122900289b4 100644 (file)
@@ -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)).