README.md 2.2 KB
Newer Older
Joaquin A. Decima's avatar
UPDATE  
Joaquin A. Decima committed
1
![ngx-youtube-player-logo](https://raw.githubusercontent.com/SamirHodzic/ngx-youtube-player/master/src/assets/logo_git.png)
Joaquin A. Decima's avatar
Joaquin A. Decima committed
2

Joaquin A. Decima's avatar
UPDATE  
Joaquin A. Decima committed
3 4 5 6
# ngx-YouTube-Player
[![build-url][build-url-svg]][build-url]
[![Dependencies][dependencies]][dependencies-url]
[![Dev Dependencies][dev-dependencies]][dev-dependencies-url]
Joaquin A. Decima's avatar
Joaquin A. Decima committed
7

Joaquin A. Decima's avatar
UPDATE  
Joaquin A. Decima committed
8
> YouTube player app built with Angular 7 (latest 7.1.4).
Joaquin A. Decima's avatar
Joaquin A. Decima committed
9

Joaquin A. Decima's avatar
UPDATE  
Joaquin A. Decima committed
10
[Demo](https://samirhodzic.github.io/ngx-youtube-player) (Updated: 06/01/2019)
Joaquin A. Decima's avatar
Joaquin A. Decima committed
11

Joaquin A. Decima's avatar
UPDATE  
Joaquin A. Decima committed
12
## Quickstart
Joaquin A. Decima's avatar
Joaquin A. Decima committed
13

Joaquin A. Decima's avatar
UPDATE  
Joaquin A. Decima committed
14
**Note**: Require Node 4+ together with Npm 3+, also be sure to install
Joaquin A. Decima's avatar
Joaquin A. Decima committed
15

Joaquin A. Decima's avatar
UPDATE  
Joaquin A. Decima committed
16
**1- Install [Angular-CLI](https://github.com/angular/angular-cli) (latest 7.1.4) :**
Joaquin A. Decima's avatar
Joaquin A. Decima committed
17

Joaquin A. Decima's avatar
UPDATE  
Joaquin A. Decima committed
18 19 20
```bash
$ npm install -g @angular/cli@latest
```
Joaquin A. Decima's avatar
Joaquin A. Decima committed
21

Joaquin A. Decima's avatar
UPDATE  
Joaquin A. Decima committed
22
**2- Clone the project:**
Joaquin A. Decima's avatar
Joaquin A. Decima committed
23

Joaquin A. Decima's avatar
UPDATE  
Joaquin A. Decima committed
24 25 26 27
```bash
$ git clone https://github.com/SamirHodzic/ngx-youtube-player
$ cd ngx-youtube-player
```
Joaquin A. Decima's avatar
Joaquin A. Decima committed
28

Joaquin A. Decima's avatar
UPDATE  
Joaquin A. Decima committed
29
**3- Install the npm packages described in the package.json :**
Joaquin A. Decima's avatar
Joaquin A. Decima committed
30

Joaquin A. Decima's avatar
UPDATE  
Joaquin A. Decima committed
31 32 33
```bash
$ npm install
```
Joaquin A. Decima's avatar
Joaquin A. Decima committed
34

Joaquin A. Decima's avatar
UPDATE  
Joaquin A. Decima committed
35
**4- Transpile typescript into javascript, host the app and monitor the changes :**
Joaquin A. Decima's avatar
Joaquin A. Decima committed
36

Joaquin A. Decima's avatar
UPDATE  
Joaquin A. Decima committed
37 38 39
```bash
$ ng serve
```
Joaquin A. Decima's avatar
Joaquin A. Decima committed
40

Joaquin A. Decima's avatar
UPDATE  
Joaquin A. Decima committed
41
Visit http://localhost:4200 and enjoy!
Joaquin A. Decima's avatar
Joaquin A. Decima committed
42

Joaquin A. Decima's avatar
UPDATE  
Joaquin A. Decima committed
43 44 45 46
## Dependencies
- [Angular](https://angular.io/) with [Typescript](https://www.typescriptlang.org/)
- [Angular CLI](https://cli.angular.io/)
- [Material Design Lite](https://github.com/google/material-design-lite/)
Joaquin A. Decima's avatar
Joaquin A. Decima committed
47

Joaquin A. Decima's avatar
UPDATE  
Joaquin A. Decima committed
48 49 50 51 52 53 54 55
## Features
- Play music while searching
- Extended controls
- Shuffle/Repeat options for your playlists
- Browser notifications when new song is going to start
- Different type for video displaying
- Create local playlist without authorization
- Simple Import/Export playlists as JSON
Joaquin A. Decima's avatar
Joaquin A. Decima committed
56

Joaquin A. Decima's avatar
UPDATE  
Joaquin A. Decima committed
57 58 59 60 61 62 63
## TODO
- ~~'Now playing' when video is minimized~~
- ~~Update UI to be fully responsive for mobile/tablet~~
- ~~Browser notification interface when new song is going to start~~
- Save multiple playlists and switch between them
- Write tests
- ...
Joaquin A. Decima's avatar
Joaquin A. Decima committed
64 65


Joaquin A. Decima's avatar
UPDATE  
Joaquin A. Decima committed
66 67 68 69 70 71
[dependencies]: https://david-dm.org/samirhodzic/ngx-youtube-player.svg
[dependencies-url]: https://david-dm.org/samirhodzic/ngx-youtube-player
[dev-dependencies]: https://david-dm.org/samirhodzic/ngx-youtube-player/dev-status.svg
[dev-dependencies-url]: https://david-dm.org/samirhodzic/ngx-youtube-player?type=dev
[build-url]: https://travis-ci.org/SamirHodzic/ngx-youtube-player
[build-url-svg]: https://travis-ci.org/SamirHodzic/ngx-youtube-player.svg?branch=master