Skip to content

Commit 508e113

Browse files
Update README.md
1 parent 1473f98 commit 508e113

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,49 @@
1-
# ApiRTC-Angular
1+
# ApiRTC over Angular Steps by Steps Tutorial
22

33
This project is a very simple **angular** application using **ApiRTC**.
44

55
It is running **live** hosted on github.io : https://apizee.github.io/ApiRTC-angular/.
66

7-
This is also a **tutorial** as this README lists the steps that created the project.
7+
This is also a **tutorial** as this README lists the steps that created the project from scratch.
88

9-
## ApiRTC over Angular Steps by Steps Tutorial
10-
11-
Starting from scratch, first install angular cli (command line interface) :
9+
## Intall angular command line interface
1210

1311
`sudo npm install -g @angular/cli`
1412

1513
(This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 11.2.12.)
1614

17-
Create the new angular app :
15+
## Create the new angular app
1816

1917
`ng new ApiRTC-angular`
2018

2119
`cd ApiRTC-angular`
2220

23-
Import angular-material that will be used to produce nice form :
21+
## Import angular-material
22+
23+
This will be used to produce nice form ;)
2424

2525
`ng add @angular/material`
2626

27-
Import **ApiRTC** :
27+
## Import **ApiRTC**
2828

2929
`npm install @apizee/apirtc@latest --save`
3030

31-
In `src/app/app.module.ts` add imports of modules for angular reactive forms and @angular/material.
31+
## Code the application
3232

33-
Replaced default content of `src/app/app.component.html` with a simple form to enter conversation name and tags for remote and local videos.
33+
Please check the code in this repo. Following is the exhaustive list of modified files and how :
3434

35-
Copy code from first Conversation tutorial (https://github.com/apizee/ApiRTC-examples/blob/master/conferencing/js/conference.js) in `src/app/app.component.ts` and adapt to typescript and angular.
35+
In `src/app/app.module.ts` add imports of modules for angular reactive forms and @angular/material.
3636

37-
Run `ng serve`
37+
Replaced default content of `src/app/app.component.html` with a simple form to enter conversation name and tags for remote and local videos.
3838

39-
The application can be opened in multiple tabs to test **ApiRTC** conversation with **multiple peers**.
39+
Copied code from first Conversation tutorial (https://github.com/apizee/ApiRTC-examples/blob/master/conferencing/js/conference.js) in `src/app/app.component.ts` and adapt to typescript and angular.
4040

41-
## Development server
41+
## Run in Development mode
4242

4343
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
4444

45+
The application can be opened in multiple tabs to test **ApiRTC** conversation with **multiple peers**.
46+
4547
## Build
4648

4749
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.

0 commit comments

Comments
 (0)