Need to Know

AI-powered news aggregator. Stay informed. Stay ahead.

Need to Know is a modern news aggregation platform that leverages AI to curate and summarize the most relevant news for you. Built with Next.js and powered by cutting-edge technologies, this application provides a seamless and personalized news reading experience.

Features

• AI-Powered Curation: Get news tailored to your interests using advanced AI algorithms.
• Real-Time Updates: Stay updated with the latest news as it happens.
• Personalized Feed: Customize your news feed based on topics, sources, and preferences.
• Modern UI: Enjoy a clean, intuitive interface built with shadcn/ui and Tailwind CSS.
• Responsive Design: Access your news on any device, anywhere.

Tech Stack

• Frontend: Next.js 15.3.0, React 19.0.0
• Styling: Tailwind CSS, styled-components
• UI Components: shadcn/ui, Radix UI
• State Management: SWR for data fetching
• Icons: Lucide React, FontAwesome
• Animations: tw-animate-css
• Package Manager: Bun

Getting Started

Prerequisites

• Node.js (version 20 or higher)
• Bun (latest version)

Installation

1. Clone the repository:

   git clone https://github.com/yannvr/needtoknow.git
   cd needtoknow

2. Install dependencies using Bun:

   bun install

3. Start the development server:

   bun run dev

   The application will be available at http://localhost:3000.

Usage

• Open your browser and navigate to http://localhost:3000.
• Sign up or log in to personalize your news feed.
• Explore trending news or customize your topics of interest.
• Click on articles to read AI-generated summaries or view full content.

Development

Scripts

• Development Server: bun run dev - Starts the Next.js development server with Turbopack.
• Build: bun run build - Creates a production build of the application.
• Start: bun run start - Runs the production build.
• Lint: bun run lint - Runs ESLint to check for code quality issues.
• Test: bun run test - Runs the test suite.
• Test Watch: bun run test:watch - Runs tests in watch mode.
• Test Coverage: bun run test:coverage - Runs tests with coverage reporting.

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a new branch with a descriptive name related to your feature or fix.
3. Make your changes and commit them following the conventional commits format.
4. Push your branch to your fork.
5. Open a pull request with a detailed description of your changes.

License

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

Contact

For questions or feedback, please open an issue on GitHub or contact the project maintainer.

---

Built with ❤️ and AI for news enthusiasts everywhere.