2018-02-22 16:11:04 +00:00
<!DOCTYPE html>
<!-- [if IE 8]><html class="no - js lt - ie9" lang="en" > <![endif] -->
<!-- [if gt IE 8]><! --> < html class = "no-js" lang = "en" > <!-- <![endif] -->
< head >
< meta charset = "utf-8" >
2018-02-22 18:22:22 +00:00
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
2018-02-22 16:11:04 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< link rel = "shortcut icon" href = "../img/favicon.ico" >
2018-04-08 20:02:44 +00:00
< title > Prepare everything - NewPipe Documentation< / title >
2018-02-23 20:18:58 +00:00
< link rel = "stylesheet" href = "../css/local_fonts.css" type = "text/css" / >
2018-02-22 16:11:04 +00:00
< link rel = "stylesheet" href = "../css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "../css/theme_extra.css" type = "text/css" / >
2018-02-23 20:18:58 +00:00
< link rel = "stylesheet" href = "../css/highlight.css" type = "text/css" / >
2018-02-22 16:11:04 +00:00
< script >
// Current page data
2018-02-22 18:22:22 +00:00
var mkdocs_page_name = "Prepare everything";
var mkdocs_page_input_path = "00_Prepare_everything.md";
var mkdocs_page_url = "/00_Prepare_everything/";
2018-02-22 16:11:04 +00:00
< / script >
< script src = "../js/jquery-2.1.1.min.js" > < / script >
< script src = "../js/modernizr-2.8.3.min.js" > < / script >
2018-02-22 18:22:22 +00:00
< script type = "text/javascript" src = "../js/highlight.pack.js" > < / script >
2018-02-22 16:11:04 +00:00
< / head >
< body class = "wy-body-for-nav" role = "document" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side stickynav" >
< div class = "wy-side-nav-search" >
2018-04-08 20:02:44 +00:00
< a href = ".." class = "icon icon-home" > NewPipe Documentation< / a >
2018-02-22 16:11:04 +00:00
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "../search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< / form >
< / div >
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
2018-02-22 18:22:22 +00:00
< ul class = "current" >
2018-02-22 16:11:04 +00:00
2018-02-22 18:22:22 +00:00
< li class = "toctree-l1" >
2018-04-08 20:02:44 +00:00
< a class = "" href = ".." > Welcome to the NewPipe Documentaiton.< / a >
2018-02-22 18:22:22 +00:00
< / li >
2018-02-22 16:11:04 +00:00
2018-02-22 18:22:22 +00:00
< li class = "toctree-l1 current" >
< a class = "current" href = "./" > Prepare everything< / a >
< ul class = "subnav" >
2018-02-22 16:11:04 +00:00
2018-02-22 18:22:22 +00:00
< li class = "toctree-l2" > < a href = "#prepare-everything" > Prepare everything< / a > < / li >
< ul >
2018-02-22 16:11:04 +00:00
2018-02-22 18:22:22 +00:00
< li > < a class = "toctree-l3" href = "#setup-your-dev-environment" > Setup your dev environment< / a > < / li >
< / ul >
< / ul >
< / li >
< li class = "toctree-l1" >
2018-02-24 21:17:40 +00:00
< a class = "" href = "../01_Concept_of_the_extractor/" > 01 Concept of the extractor< / a >
2018-02-22 18:22:22 +00:00
< / li >
2018-02-22 16:11:04 +00:00
< / ul >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" role = "navigation" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
2018-04-08 20:02:44 +00:00
< a href = ".." > NewPipe Documentation< / a >
2018-02-22 16:11:04 +00:00
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = ".." > Docs< / a > » < / li >
2018-02-22 18:22:22 +00:00
< li > Prepare everything< / li >
2018-02-22 16:11:04 +00:00
< li class = "wy-breadcrumbs-aside" >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" >
< div class = "section" >
< h1 id = "prepare-everything" > Prepare everything< / h1 >
2018-02-22 18:22:22 +00:00
< p > Welcome to the NewPipe tutorial. This tutorial will guide you through the process of creating your own NewPipeExtractor
service with which NewPipe will gain support for a dedicated streaming service like YouTube, Vimeo or SournCloud. Let's
dive right. ;D< / p >
2018-02-22 16:11:04 +00:00
< h2 id = "setup-your-dev-environment" > Setup your dev environment< / h2 >
< p > First and foremost you need to meet certain conditions in order to write your own service.< / p >
< h3 id = "what-you-need-to-know" > What you need to know< / h3 >
< ul >
< li > Basic understanding of < strong > < a href = "https://try.github.io" > git< / a > < / strong > < / li >
< li > Good < strong > < a href = "http://whatpixel.com/best-java-books/" > Java< / a > < / strong > knowledge< / li >
< li > Good understanding of < strong > < a href = "https://www.w3schools.com/" > web technology< / a > < / strong > < / li >
< li > Basic understanding about < strong > < a href = "http://www.vogella.com/tutorials/JUnit/article.html" > unit testing< / a > < / strong > and < strong > < a href = "https://junit.org/" > JUnit< / a > < / strong > < / li >
< li > Flawless understanding of how to < a href = "https://github.com/TeamNewPipe/NewPipe/blob/dev/.github/CONTRIBUTING.md#code-contribution" > contribute< / a > to the < strong > NewPipe project< / strong > < / li >
< / ul >
< h3 id = "what-you-need-to-have" > What you need to have< / h3 >
< ul >
< li > A dev environment/ide that supports:< ul >
< li > < strong > < a href = "https://git-scm.com/downloads/guis" > git< / a > < / strong > < / li >
< li > < strong > < a href = "https://www.java.com/en/download/faq/java8.xml" > java 8< / a > < / strong > < / li >
< li > < strong > < a href = "https://gradle.org/" > gradle< / a > < / strong > < / li >
< li > I highly recomend < a href = "https://www.jetbrains.com/idea/" > IDEA Community< / a > since it has everything we need.< / li >
< / ul >
< / li >
< li > A < strong > < a href = "https://github.com/" > github< / a > < / strong > account< / li >
< li > A loot of patience and excitement ;D< / li >
< / ul >
< p > After making sure all these conditions are provided fork the < a href = "https://github.com/TeamNewPipe/NewPipeExtractor" > NewPipeExtractor< / a > ,
using the < a href = "https://github.com/TeamNewPipe/NewPipeExtractor#fork-destination-box" > fork button< / a > .
This way you have your own working repository. Now clone this repository into your local folder in which you want to work in.
Next import the cloned project into your < a href = "https://www.jetbrains.com/help/idea/configuring-projects.html#importing-project" > ide< / a >
and < a href = "https://www.jetbrains.com/help/idea/performing-tests.html" > run< / a > it.
If all the checks are green you did everything right, and you are good to go to move on to the next chapter.
< img alt = "tests passed on idea" src = "../img/prepare_tests_passed.png" / > < / p >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
2018-02-24 21:17:40 +00:00
< a href = "../01_Concept_of_the_extractor/" class = "btn btn-neutral float-right" title = "01 Concept of the extractor" > Next < span class = "icon icon-circle-arrow-right" > < / span > < / a >
2018-02-22 18:22:22 +00:00
2018-02-22 16:11:04 +00:00
2018-04-08 20:02:44 +00:00
< a href = ".." class = "btn btn-neutral" title = "Welcome to the NewPipe Documentaiton." > < span class = "icon icon-circle-arrow-left" > < / span > Previous< / a >
2018-02-22 16:11:04 +00:00
< / div >
< hr / >
< div role = "contentinfo" >
<!-- Copyright etc -->
< / div >
Built with < a href = "http://www.mkdocs.org" > MkDocs< / a > using a < a href = "https://github.com/snide/sphinx_rtd_theme" > theme< / a > provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
2018-02-22 18:22:22 +00:00
2018-02-22 16:11:04 +00:00
< / div >
< / div >
< / section >
< / div >
2018-02-22 18:22:22 +00:00
< div class = "rst-versions" role = "note" style = "cursor: pointer" >
2018-02-22 16:11:04 +00:00
< span class = "rst-current-version" data-toggle = "rst-current-version" >
< span > < a href = ".." style = "color: #fcfcfc;" > « Previous< / a > < / span >
2018-02-24 21:17:40 +00:00
< span style = "margin-left: 15px" > < a href = "../01_Concept_of_the_extractor/" style = "color: #fcfcfc" > Next » < / a > < / span >
2018-02-22 18:22:22 +00:00
2018-02-22 16:11:04 +00:00
< / span >
< / div >
2018-02-22 18:22:22 +00:00
< script > var base _url = '..' ; < / script >
< script src = "../js/theme.js" > < / script >
< script src = "../search/require.js" > < / script >
< script src = "../search/search.js" > < / script >
2018-02-22 16:11:04 +00:00
< / body >
< / html >
