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.
Access the live site at Project-Link
- 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.
Before you begin, ensure you have the following installed:
- Node.js: Version 20.15.1 or higher
- npm: Version 10.7.0 or higher
- React.js: For building the user interface
- Tailwind CSS: For styling
- Redux: For state management
- Typescript: For type safety
- JavaScript: Core programming language
To install and run project locally, follow these steps:
-
Clone the repository:
git clone https://github.com/ChuksJoshuaa/News-Aggregator.git
-
Install the repository:
npm install --force
-
Build the repository with docker:
docker-compose up --build
To start the application and begin using project, follow these steps:
- Start the application:
npm run dev
- Open your web browser and navigate to
http://localhost:5173
To run the Cypress end-to-end tests, use the following command:
npm run open:cypress
Contributions are welcome! To contribute to project, follow these steps:
- Fork the repository.
- Create a new branch:
git checkout -b feature/your-feature-name
- Make your changes and commit them:
git commit -m 'Add some feature'
- Push to the branch:
git push origin feature/your-feature-name
- Submit a pull request.