Martynique !

Welcome guys for a intensive programming week! We have to develop a desktop app interfacing with Youtube. You can find the video presentation at the following link: https://youtu.be/AqRh3hZBHRk

#Before starting

First of all, install all softwares you need to work. Minimum requirements are:

• an IDE (eclipse, IntelliJ IDEA, netBeans)
• Git (surprising isn't it ?)
• JUnit4 (Who will make tests?)
• SceneBuilder if we choose javaFX (We have choosen JavaFX :D)
• The build manager maven(useful for dependancies)
• FFmpeg

Ok, here we are! Be sure you can clone the repo (use SSH keys to be faster).

#Config the ID clients OAuth 2.0 is stored in src/main/resources/secrets.json

{
	"installed": {
		"client_id": "XXXXX",
	    "client_secret": "XXXXX"
	}
}

The API key is stored in src/main/resources/youtube.properties

youtube.apikey=XXXXX

To download some videos FFmpeg is required. Please make sure FFmpeg is installed and added to your PATH variable.

#Dependancies

for more details, check the pom.xml !

• Youtube API Client Library for Java, communication with the Youtube API
• javaFX, building of modern user interfaces in java 8
• [FFmpeg] (https://ffmpeg.org/), a powerfull media manipulation tool

#Install

We used maven to build the JAR file. execute this command to build it:

mvn package

It will generate the Martynique.jar into the target/ directory.

java -jar target/Martynique.jar

Have fun!

Roles

@Mcdostone: Project manager

@MartyEz: Crazy coder

@Answermouth: User Interface Developer and test developper

@Minous: User Interface Developer and test developper

Expected features

1. Searching a video using the Youtube API
2. Watching a video hosted on Youtube
3. Getting the list of videos depending on a user query
4. Controlling the video player (play, pause, volume, fullscreen ...)
5. Watching an offline video
6. Saving favorites videos
7. Creating a playlist
8. Improving user experience thanks to advanced thumbnails
9. Suggesting videos the user depending on its criteria
10. Making navigation more easier for the user
11. Authentificating the user on Youtube
12. Commenting or liking a video
13. Displaying more information about a video (comments, description)
14. unit tests

Initial planning

https://trello.com/b/R2oF29tT/planning-initial

Actual Roadmap

https://trello.com/b/BS6gIe2i/pcd-martynique

Final features

• Online viewing
• Offline viewing
• Download videos
• Search
• Favorite videos
• Playlists
• Settings in home
• Possibility to choose location of database and downloaded files
• Suggest a curated video depending on certain criterias

Class diagrammes

You can find them in /doc/class_diagrammes

Unit test

You can find the unit tests in the test package.

Some resources

• Jfoenix, implementation of Google Material Design using Java components.
• Example of JavaFX app
• [Color specifications of Youtube] (https://www.youtube.com/yt/brand/color.html)

#authors

@MartyEz, Lucas MARTINEZ

@Answermouth, Ansel GAMET

@Minious, Eliot GODARD

@Mcdostone, Yann PRONOs