Fake News is an application that focuses on utilisation of the NewsApi to display news from the various sources that are provided therein as well as providing additoinal navigational functionality to cater to the use cases beyond the display of news sources.
This project is built with Gradle, the Android Gradle Plugin Follow the steps below to setup the project locally
- Install
Java JDK
version 8
- Clone FakeNews into your working folder
- Generate an apikey from NewsApi
- Generate a variable inside the gradle.properties file called
apiKey
that you shall use your api-key - Start Android Studio
- Select OpenProject and select the generated root project folder from your git clone
- Once the project has compiled -> RUn the project
There are two ways to do this the first being accessing the Gradle
menu on the right hand side of the IDE and then clicking on the git hooks
section, followed by clicking the function installGitHookls
Additionally, the command ./gradlew installGitHooks
can be run from inside the terminal top ensure that the pre-commit hook is successfully installed.
./gradlew connectedCheck
Please make sure that an emulator is connected to avoid tests failing
This command runs both Insturmentation and Unit Tests that are collectively reported by jacoco
Use the Android Studio Build Variants button to choose between debug and release flavors combined with debug and release build types
Fake news utilises the following end points
- Sources All News sources
- Everything All Data from a particular news source
- Serach Query all news about a search query with the most recent first.
This project is mantained by:
- Fork it
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -m 'Add some feature')
- Run the linter (ruby lint.rb').
- Push your branch (git push origin my-new-feature)
- Create a new Pull Request