237 lines
9.2 KiB
HTML
237 lines
9.2 KiB
HTML
<!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">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
|
|
<link rel="shortcut icon" href="../img/favicon.ico">
|
|
<title>Testing Your Changes in the App - NewPipe Documentation</title>
|
|
<!-- local fonts -->
|
|
<link rel="stylesheet" href="../css/local_fonts.css" type="text/css" />
|
|
|
|
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/theme_child.css" type="text/css" />
|
|
<!-- local code syntax highlighting -->
|
|
<link rel="stylesheet" href="../css/github.min.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/highlight.css" type="text/css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Testing Your Changes in the App";
|
|
var mkdocs_page_input_path = "04_Run_changes_in_App.md";
|
|
var mkdocs_page_url = null;
|
|
</script>
|
|
|
|
<script src="../js/jquery-2.1.1.min.js" defer></script>
|
|
<script src="../js/modernizr-2.8.3.min.js" defer></script>
|
|
<script src="../js/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
|
|
</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">
|
|
<a href=".." class="icon icon-home"> NewPipe Documentation</a>
|
|
<div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
<ul class="current">
|
|
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="..">Welcome to NewPipe.</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="../00_Prepare_everything/">Before You Start</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="../03_Implement_a_service/">Implementing a Service</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1 current">
|
|
|
|
<a class="current" href="./">Testing Your Changes in the App</a>
|
|
<ul class="subnav">
|
|
|
|
<li class="toctree-l2"><a href="#testing-your-changes-in-the-app">Testing Your Changes in the App</a></li>
|
|
|
|
<ul>
|
|
|
|
<li><a class="toctree-l3" href="#setup-android-studio">Setup Android Studio</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#get-the-newpipe-code-and-run-it">Get the NewPipe Code and Run it.</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#run-your-changes-on-the-extractor">Run Your Changes on the Extractor</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#troubleshooting">Troubleshooting</a></li>
|
|
|
|
</ul>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="../05_releasing/">Releasing a New NewPipe Version</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="../06_documentation/">About This Documentation</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="../07_maintainers_view/">Maintainers' Section</a>
|
|
</li>
|
|
|
|
</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>
|
|
<a href="..">NewPipe Documentation</a>
|
|
</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>
|
|
|
|
|
|
|
|
<li>Testing Your Changes in the App</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
|
|
<h1 id="testing-your-changes-in-the-app">Testing Your Changes in the App</h1>
|
|
<p>You should develop and test your changes with the JUnit environment that is
|
|
provided by the NewPipe Extractor and IDEA. If you want to try it with
|
|
the actual fronted, you need to follow these steps.</p>
|
|
<h3 id="setup-android-studio">Setup Android Studio</h3>
|
|
<p>First, you'll want to set up a working Android Studio environment. To do this,
|
|
download Studio from <a href="https://developer.android.com/studio/">developer.android.com</a>,
|
|
and follow the <a href="https://developer.android.com/studio/install">instructions</a> on how to set it up.</p>
|
|
<h3 id="get-the-newpipe-code-and-run-it">Get the NewPipe Code and Run it.</h3>
|
|
<p>In order to get it, you simply clone or download it from the current <code>dev</code> branch
|
|
<a href="https://github.com/TeamNewPipe/NewPipe/archive/dev.zip">github.com/TeamNewPipe/NewPipe.git</a>.
|
|
You can then build and run it following <a href="https://developer.android.com/studio/run/">these instructions</a>.
|
|
Also, make sure you are comfortable with <a href="https://en.droidwiki.org/wiki/Android_Debug_Bridge">adb</a> since
|
|
you might experience some trouble running your compiled app on a real device, especially under Linux, where you
|
|
sometimes have to adjust the udev rules in order to
|
|
<a href="https://www.janosgyerik.com/adding-udev-rules-for-usb-debugging-android-devices/">make your device accessible</a>.</p>
|
|
<h3 id="run-your-changes-on-the-extractor">Run Your Changes on the Extractor</h3>
|
|
<p>In order to use the extractor in our app, we use <a href="https://jitpack.io">jitpack</a>. This is a build service that can build
|
|
maven *.jar packages for Android and Java based on GitHub or GitLab repositories. </p>
|
|
<p>To use the extractor through jitpack, you need to push it to your online repository of
|
|
your copy that you host either on <a href="https://github.com">GitHub</a> or <a href="https://gitlab.com">GitLab</a>. It's important to host
|
|
it on one of both. To copy your repository URL in HTTP format, go to <a href="https://jitpack.io/">jitpack</a> and paste it there.
|
|
From here, you can grab the latest commit via <code>GET IT</code> button.
|
|
I recomend not to use a SNAPSHOT, since I am not sure when snapshot is built. An "implementation" string will be generated
|
|
for you. Copy this string and replace the <code>implementation 'com.github.TeamNewPipe:NewPipeExtractor:<commit>'</code> line in
|
|
the file <a href="https://github.com/TeamNewPipe/NewPipe/blob/dev/app/build.gradle#L58">/app/build.gradle</a> with it.</p>
|
|
<video width="600" controls>
|
|
<source src="../media/how_to_jitpack.mp4" type="video/mp4">
|
|
Your browser does not support the video tag.
|
|
</video>
|
|
|
|
<p>If everything synced well, then you should only see a screen with OK signs. Now you can compile and run NewPipe
|
|
with the new extractor.</p>
|
|
<p><img alt="image_sync_ok" src="../img/sync_ok.png" /></p>
|
|
<h3 id="troubleshooting">Troubleshooting</h3>
|
|
<p>If something went wrong on jitpack site, you can check their build log, by selecting the commit you tried to build and
|
|
click on that little paper symbol next to the <code>GET IT</code> button. If it's red, it means that the build failed.
|
|
<img alt="jitpack failed to build" src="../img/jitpack_fail.png" /></p>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="../05_releasing/" class="btn btn-neutral float-right" title="Releasing a New NewPipe Version">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href="../03_Implement_a_service/" class="btn btn-neutral" title="Implementing a Service"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
|
|
</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>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" style="cursor: pointer">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
|
|
<span><a href="../03_Implement_a_service/" style="color: #fcfcfc;">« Previous</a></span>
|
|
|
|
|
|
<span style="margin-left: 15px"><a href="../05_releasing/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
|
|
</body>
|
|
</html>
|