Nimbus

Status: Completed

A summarized news & weather app.

Explore the docs »
Report a Bug · Request new Feature

Welcome to Nimbus, designed to keep you effortlessly informed and updated. Our app offers succinct summaries of the day's top stories, ensuring you stay informed without overwhelming you with lengthy articles. You can dive deeper into specific topics with categorized news sections such as Top Stories, Trending topics, and more, providing comprehensive coverage across various interests. Bookmark articles that catch your eye for later reading and personalize your news feed with our easy-to-use search function that allows you to find articles by keywords. Stay ahead of the weather with real-time updates, offering detailed forecasts on both daily and hourly bases. Whether you prefer to browse in Light or Dark Mode, our app ensures a customizable viewing experience to suit your preference. Sign up today to unlock these features and start enjoying a streamlined news and weather experience tailored just for you.

Supports Android 10 & above only.

• Summarized News: Concise summaries of current events and headlines.
• News Categories:
  • Top Stories: Highlighted news articles and breaking stories.
  • All News: Comprehensive coverage across all categories.
  • Trending: Popular topics gaining traction in real-time.
  • Recent: Recently published articles and updates.
  • Bookmark: Save articles to read later.
• Articles by Topics: Explore articles categorized into various topics of interest.
• Search Articles by Keyword: Find specific articles using keywords or phrases.
• Bookmark Articles: Save favorite articles for easy access.
• Real-time Weather Updates:
  • Daily & Hourly: Up-to-date weather forecasts, including daily and hourly updates.
• Signup & Login: Register and log into your account to personalize your news experience.
• Light & Dark Mode: Customize the interface with light or dark themes for optimal viewing.

Follow the below instructions to get started.

1. Android Studio

2. Kotlin 1.9+

3. Python 3.12

1. Clone this repository:

   git clone https://github.com/ArmanKhanTech/Nimbus.git

2. Install all the backend dependancies:

   cd Backend
   pip install -r requirements.txt

3. Create .env file:

   touch .env

4. Add API_KEY=[YOUR_API_KEY] to .env.

5. Run the Flask development server:

   py app.py

6. Navigate to browser & verify functioning of both the endpoints:
   a. /news?key=[YOUR_API_KEY]
   b. /weather?key=[YOUR_API_KEY]&city=[CITY_NAME]
   

7. Also, add API_KEY=[YOUR_API_KEY] to local.properties in Frontend/local.properties.

8. Run the app.

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!

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

Arman Khan - ak2341776@gmail.com

Project Link - https://github.com/ArmanKhanTech/Nimbus