Skip to content

A News Aggregator App that curates and personalizes news from multiple sources, allowing users to search, filter, and stay updated on trending topics. It features a responsive design, real-time updates, and a seamless reading experience.

Notifications You must be signed in to change notification settings

ChuksJoshuaa/News-Aggregator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

News Aggregator

image

A News Aggregator App that curates and personalizes news from multiple sources, allowing users to search, filter, and stay updated on trending topics. It features a responsive design, real-time updates, and a seamless reading experience.

Demo Link

Access the live site at Project-Link

Features

  • React Router: For client-side routing.
  • Redux: For state management.
  • TypeScript: For type safety.
  • CSS Modules: For scoped and modular CSS.
  • Vite: For fast development and build tooling.

Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js: Version 20.15.1 or higher
  • npm: Version 10.7.0 or higher

Technologies Used

  • React.js: For building the user interface
  • Tailwind CSS: For styling
  • Redux: For state management
  • Typescript: For type safety
  • JavaScript: Core programming language

Installation

To install and run project locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/ChuksJoshuaa/News-Aggregator.git
  2. Install the repository:

    npm install --force
  3. Build the repository with docker:

    docker-compose up --build

Usage

To start the application and begin using project, follow these steps:

  1. Start the application:
    npm run dev
  2. Open your web browser and navigate to
    http://localhost:5173

Running Tests

To run the Cypress end-to-end tests, use the following command:

npm run open:cypress

Contributing

Contributions are welcome! To contribute to project, follow these steps:

  1. Fork the repository.
  2. Create a new branch:
    git checkout -b feature/your-feature-name
  3. Make your changes and commit them:
    git commit -m 'Add some feature'
  4. Push to the branch:
    git push origin feature/your-feature-name
  5. Submit a pull request.

About

A News Aggregator App that curates and personalizes news from multiple sources, allowing users to search, filter, and stay updated on trending topics. It features a responsive design, real-time updates, and a seamless reading experience.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •