From 63bfad7ec984dad1e9a96de1f191db5cc78db5bf Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Fri, 12 Jan 2018 18:07:41 +0100 Subject: Try to improve documentations/readme --- support/doc/development/client/code.md | 7 +------ support/doc/development/server/code.md | 15 --------------- 2 files changed, 1 insertion(+), 21 deletions(-) (limited to 'support/doc/development') 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 Uses [TSLint](https://palantir.github.io/tslint/) for TypeScript linting and [Angular styleguide](https://angular.io/docs/ts/latest/guide/style-guide.html). -## Developing - - * Install [the dependencies](https://github.com/Chocobozzz/PeerTube#dependencies) - * Run `yarn install --pure-lockfile` 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, 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`. +## Concepts 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. 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 Uses [JavaScript Standard Style](http://standardjs.com/). - -## Developing - - * Install [the dependencies](https://github.com/Chocobozzz/PeerTube#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 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 instances (see [constants.ts](https://github.com/Chocobozzz/PeerTube/blob/master/server/initializers/constants.ts)). - -`npm run help` gives you all available commands. - -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`. - - ## Architecture The server is composed by: -- cgit v1.2.3