Code Monkey home page Code Monkey logo

fakenews's Introduction

Fake News

Maintainability CircleCI

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.

Getting Started

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

Installing the Pre-commit Hook

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.

Running Tests

./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 Application Coverage

Build variants

Use the Android Studio Build Variants button to choose between debug and release flavors combined with debug and release build types

Consumed Endpoints

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.

Maintainers

This project is mantained by:

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -m 'Add some feature')
  4. Run the linter (ruby lint.rb').
  5. Push your branch (git push origin my-new-feature)
  6. Create a new Pull Request

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.