🚀 Brevity - Short, Smart, Straight to the point

Stay informed effortlessly with real-time news, seamless navigation, and a personalized reading experience.

🌟 Stars	🍴 Forks	🐛 Issues	🔔 Open PRs

This project is now OFFICIALLY accepted for

Program Name	Program Logo	Program Description
GirlScript Summer of Code		GirlScript Summer of Code is a three-month-long Open Source Program conducted every summer by GirlScript Foundation. It is an initiative to bring more beginners to Open-Source Software Development.

🎉 Exciting News! Brevity has been selected for GirlScript Summer of Code (GSSoC) 2025!

📢 Want to contribute? Join our community Discord server to connect with maintainers and fellow contributors. We welcome all contributors - from beginners to experienced developers. Let's build something amazing together! 🚀

📑 Table of Contents

1. ✨ App Demo
2. 🌟 Features
3. 🛠️ Tech Stack
4. 📲 Installation & Setup
5. 📁 Folder Structure
6. 🔮 Future Plans
7. 🤝 Contributing
8. 📄 License
9. 💬 Connect With Us

---

✨ App Demo

BrevityVideo1 Login & SignUp

BrevityVideo2 Main Features

BrevityVideo3 Additional Features

📱 View App Screenshots

---

🌟 Features

Core Features

• AI Chatbot 🤖 - Get instant answers to all your questions related to the news.
• Infinite Scrolling 🔄 - Never hit "the end" – keep scrolling for more stories!
• Side Page Navigation 📚 - Bookmark articles, adjust settings, and access more details with ease.
• Theming Support 🎨 - Users can personalize their reading experience by selecting from up to 8 themes.
• Bookmark News ⭐ - Easily bookmark news articles, with local and backend storage for seamless access across devices.
• Search News 🔍 - Quickly find news articles based on keywords or categories.
• Shareability 🤝 - Effortlessly share the app with friends using share_plus.

Technical Highlights

• State Management ⚡ – Uses flutter_bloc for efficient, scalable, and predictable state handling.
• Dynamic Routing 🚦 – Seamless navigation with go_router for a smooth user experience.
• Optimized Caching 📶 – Uses cached_network_image for efficient image loading and reduced data usage.
• Engaging Animations 🎬 – Implements shimmer effects and smooth transitions for a delightful UI.
• Modular Architecture 🏗️ – Clean and maintainable codebase with a well-structured project setup.

---

🛠️ Tech Stack

• Frontend: Flutter, Dart, BLoC for state management
• Backend: Node.js, Express.js, Mongoose, Multer, Firebase
• Local Storage: Shared Preferences
• APIs: News API, Gemini API

---

🚀 Installation & Setup

This guide will help you get BREVITY up and running on your local machine.

Prerequisites

Before you start, make sure you have the following installed:

• Flutter SDK: Version 3.29.2 or higher.
• Dart SDK: Version 3.7.2 or higher.
• Code Editor:
  • Android Studio or VS Code
  • Ensure you have the respective Flutter extensions installed.
• Git: For cloning the repository.

⚡ Quick Start

Follow these steps to set up and run the application:

1. Clone the Repository

   git clone [https://github.com/Yash159357/BREVITY](https://github.com/Yash159357/BREVITY)
   cd brevity

2. Install Dependencies

   flutter pub get

3. Configure API Keys

   Create a .env file in the root directory of your project:

   touch .env

   Add the following content to your .env file, replacing the placeholders with your actual keys:

   # .env file contents
   GEMINI_API_KEY=your_gemini_api_key_here
   NEWS_API_KEY=your_news_api_key_here

   How to get your API Keys:

   • Gemini API:
     1. Visit Google AI Studio
     2. Create a new API key.
     3. Copy the key and update GEMINI_API_KEY in your .env file.
   • News API:
     1. Visit NewsAPI.org
     2. Sign up for a free account.
     3. Copy your API key and update NEWS_API_KEY in your .env file.

4. Set Up Firebase

   To enable Firebase services (e.g., authentication, database):

   1. Go to the Firebase Console.
   2. Create a new project or select an existing one.
   3. Add your Android and/or iOS app(s) to the project.
   4. Download the configuration files:
      • For Android: google-services.json
      • For iOS: GoogleService-Info.plist
   5. Place them in the correct directories:
      • Android: android/app/google-services.json
      • iOS: ios/Runner/GoogleService-Info.plist

5. Run the Application

   # For development/debug mode
   flutter run
   
   # For a release build (optimized for performance)
   flutter run --release

📁 Folder Structure

brevity/
├── android/            # Android-specific configuration
├── assets/             # Images, logos, etc.
├── ios/                # iOS project files
├── lib/                # Flutter main code (controllers, models, views)
├── linux/              # Linux support
├── macos/              # macOS support
├── server/             # Node.js + MongoDB backend
├── test/               # Test files
├── web/                # Web support and assets
├── windows/            # Windows support
├── pubspec.yaml        # Flutter dependencies
├── README.md           # Project documentation
└── .gitignore          # Git ignore rules

🔮 Future Plans

We're constantly evolving and have some exciting ideas in the pipeline to make Brevity even more engaging and trustworthy:

• Multi-Language Support 🌍 - Expanding our reach by offering the app in multiple languages.
• Robust Backend 🔒 - Implementing email verification and forget password functionality.
• Improved Chatbot Response 🧠 - Enhancing the chatbot's ability to provide accurate and helpful information.
• App Rating and Sharing ⭐🤝 - Allowing users to rate the app and easily share it with others.
• User Preference Feed ⚙️ - Enabling users to customize their news feed based on personal preferences.
• Text-to-Speech 🗣️ - Adding an option for news articles to be read aloud.
• Reactions and Likes 👍 - Introducing features for users to react to and like news content.
• Light Mode ☀️ - Providing an alternative light theme option for personalized viewing.
• Notifications 🔔 - Implementing a notification system to keep users updated.

---

🤝 Contributing

We welcome contributions! Please follow these steps:

1. Fork the repository
2. Clone your forked repository (git clone https://github.com/Yash159357/BREVITY)
3. Create a feature branch (git checkout -b feature/amazing-feature)
4. Commit your changes (git commit -m 'Add amazing feature')
5. Push to the branch (git push origin feature/amazing-feature)
6. Open a Pull Request

---

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

✨ Get In Touch

We're excited to connect with you! Whether you have questions, ideas, or just want to be part of our journey, here’s how you can reach us.

🧑‍💻 Project Admins

Samarth Sharma Software Developer & Project Admin

Yash Software Developer & Project Admin

💬 Join the Conversation

The heart of our project is the community. Join our Discord server to ask questions, share your contributions, and collaborate with us in real-time!

---

Made with ❤️ by us