aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--README.md5
-rw-r--r--support/doc/client/code.md4
-rw-r--r--support/doc/server/code.md4
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
189 189
190 $ npm run dev:server 190 $ npm run dev:server
191 191
192The server (with the client) will listen on `localhost:9000`.
193
194
192To develop on the client side (client files are automatically compiled when we modify them): 195To develop on the client side (client files are automatically compiled when we modify them):
193 196
194 $ npm run dev:client 197 $ npm run dev:client
195 198
199The 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).
200
196**Username**: *root* <br/> 201**Username**: *root* <br/>
197**Password**: *test* 202**Password**: *test*
198 203
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
53## Developing 53## Developing
54 54
55 * Install [the dependencies](https://github.com/Chocobozzz/PeerTube#dependencies) 55 * Install [the dependencies](https://github.com/Chocobozzz/PeerTube#dependencies)
56 * Run `npm install` at the root directory to install all the dependencies 56 * Run `yarn install` at the root directory to install all the dependencies
57 * Run PostgreSQL and create the database `peertube_dev`. 57 * Run PostgreSQL and create the database `peertube_dev`.
58 * Run `npm run dev:client` to compile the client, run the server and watch client files modifications. 58 * 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`.
59 59
60In 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. 60In 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.
61If you are not familiar with Angular I recommend you to read the [quickstart guide](https://angular.io/docs/ts/latest/quickstart.html). 61If 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/).
40## Developing 40## Developing
41 41
42 * Install [the dependencies](https://github.com/Chocobozzz/PeerTube#dependencies) 42 * Install [the dependencies](https://github.com/Chocobozzz/PeerTube#dependencies)
43 * Run `npm install` at the root directory to install all the dependencies 43 * Run `yarn install` at the root directory to install all the dependencies
44 * Run PostgreSQL and create the database `peertube_dev`. 44 * Run PostgreSQL and create the database `peertube_dev`.
45 * Run `npm run dev:server` to compile the client, run the server and watch server files modifications. 45 * 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`.
46 46
47The `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)). 47The `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)).
48 48