Dinko 🗞

When News Matters, It Matters Where You Get Your News.
Explore the docs »

Report Bug · License · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

An awesome news application with interactive and user friendly interface. Fetches the freshly brewed news from around you to keep you up dated.

Some insights:

• The application is built with Koltin
• This app uses NewsAPI to get various sources and each source can provide major headlines.
• It uses Retrofit 2 to fetch news sources and news headlines from the API and displays in a RecyclerView.

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

Follow the steps to setup the project in your local machine

1. Generate an API key from NewsAPI
2. Clone the repo

   git clone https://github.com/1HazArd1/Dinko.git

3. Install NPM packages

   npm install

4. Enter your API in config.js

   const API_KEY = 'ENTER YOUR API';

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Improve the User Interface
• Each Feed should open up a fragment with various options for users instead of web view
• Add Save News feature
• Add share News feature
• Option for a news feed of a particular country

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Contact

Aakash Sinha - LinkedIn

Project Link: https://github.com/1HazArd1/Dinko

(back to top)