diff options
Diffstat (limited to 'support/doc/development')
| -rw-r--r-- | support/doc/development/client/code.md | 7 | ||||
| -rw-r--r-- | support/doc/development/server/code.md | 15 |
2 files changed, 1 insertions, 21 deletions
diff --git a/support/doc/development/client/code.md b/support/doc/development/client/code.md index ddd277e54..749783c29 100644 --- a/support/doc/development/client/code.md +++ b/support/doc/development/client/code.md | |||
| @@ -53,12 +53,7 @@ Details of the Angular application file structure. It tries to follow [the offic | |||
| 53 | 53 | ||
| 54 | Uses [TSLint](https://palantir.github.io/tslint/) for TypeScript linting and [Angular styleguide](https://angular.io/docs/ts/latest/guide/style-guide.html). | 54 | Uses [TSLint](https://palantir.github.io/tslint/) for TypeScript linting and [Angular styleguide](https://angular.io/docs/ts/latest/guide/style-guide.html). |
| 55 | 55 | ||
| 56 | ## Developing | 56 | ## Concepts |
| 57 | |||
| 58 | * Install [the dependencies](https://github.com/Chocobozzz/PeerTube#dependencies) | ||
| 59 | * Run `yarn install --pure-lockfile` at the root directory to install all the dependencies | ||
| 60 | * Run PostgreSQL and create the database `peertube_dev`. | ||
| 61 | * 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`. | ||
| 62 | 57 | ||
| 63 | In a Angular application, we create components that we put together. Each component is defined by an HTML structure, a TypeScript file and optionally a SASS file. | 58 | In a Angular application, we create components that we put together. Each component is defined by an HTML structure, a TypeScript file and optionally a SASS file. |
| 64 | If you are not familiar with Angular I recommend you to read the [quickstart guide](https://angular.io/docs/ts/latest/quickstart.html). | 59 | 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/development/server/code.md b/support/doc/development/server/code.md index d909b0c3d..ddb93119b 100644 --- a/support/doc/development/server/code.md +++ b/support/doc/development/server/code.md | |||
| @@ -36,21 +36,6 @@ All other server files are in the [server](https://github.com/Chocobozzz/PeerTub | |||
| 36 | 36 | ||
| 37 | Uses [JavaScript Standard Style](http://standardjs.com/). | 37 | Uses [JavaScript Standard Style](http://standardjs.com/). |
| 38 | 38 | ||
| 39 | |||
| 40 | ## Developing | ||
| 41 | |||
| 42 | * Install [the dependencies](https://github.com/Chocobozzz/PeerTube#dependencies) | ||
| 43 | * Run `yarn install` at the root directory to install all the dependencies | ||
| 44 | * Run PostgreSQL and create the database `peertube_dev`. | ||
| 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 | |||
| 47 | The `NODE_ENV=test` is set to speed up communications between instances (see [constants.ts](https://github.com/Chocobozzz/PeerTube/blob/master/server/initializers/constants.ts)). | ||
| 48 | |||
| 49 | `npm run help` gives you all available commands. | ||
| 50 | |||
| 51 | If you want to test the decentralization feature, you can easily run 3 instances by running `npm run play`. The instances password are `test1`, `test2` and `test3`. | ||
| 52 | |||
| 53 | |||
| 54 | ## Architecture | 39 | ## Architecture |
| 55 | 40 | ||
| 56 | The server is composed by: | 41 | The server is composed by: |