be-gay-do-crimes
/
newpipe-documentation
mirror of https://github.com/TeamNewPipe/documentation
1
0
Fork 0
Code Issues Releases Wiki Activity
newpipe-documentation/docs/00_Prepare_everything.md

37 lines
2.0 KiB
Markdown
Raw Normal View History

add Prepare Everything page add Prepare Everything page
2018-02-22 16:11:19 +00:00
# Prepare everything
add basic extractor/collector pattern
2018-02-22 18:17:23 +00:00
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
add Prepare Everything page add Prepare Everything page
2018-02-22 16:11:19 +00:00
## Setup your dev environment
First and foremost you need to meet certain conditions in order to write your own service.
### What you need to know
- Basic understanding of __[git](https://try.github.io)__
- Good __[Java](http://whatpixel.com/best-java-books/)__ knowledge
- Good understanding of __[web technology](https://www.w3schools.com/)__
- Basic understanding about __[unit testing](http://www.vogella.com/tutorials/JUnit/article.html)__ and __[JUnit](https://junit.org/)__
- Flawless understanding of how to [contribute](https://github.com/TeamNewPipe/NewPipe/blob/dev/.github/CONTRIBUTING.md#code-contribution) to the __NewPipe project__
### What you need to have
- A dev environment/ide that supports:
- __[git](https://git-scm.com/downloads/guis)__
- __[java 8](https://www.java.com/en/download/faq/java8.xml)__
- __[gradle](https://gradle.org/)__
- I highly recomend [IDEA Community](https://www.jetbrains.com/idea/) since it has everything we need.
- A __[github](https://github.com/)__ account
- A loot of patience and excitement ;D
After making sure all these conditions are provided fork the [NewPipeExtractor](https://github.com/TeamNewPipe/NewPipeExtractor),
using the [fork button](https://github.com/TeamNewPipe/NewPipeExtractor#fork-destination-box).
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 [ide](https://www.jetbrains.com/help/idea/configuring-projects.html#importing-project)
and [run](https://www.jetbrains.com/help/idea/performing-tests.html) it.
If all the checks are green you did everything right, and you are good to go to move on to the next chapter.
![tests passed on idea](img/prepare_tests_passed.png)