Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chuksjoshuaa/news-aggregator
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.
https://github.com/chuksjoshuaa/news-aggregator
cypress reactjs redux-toolkit tailwindcss typescript
Last synced: 1 day ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/chuksjoshuaa/news-aggregator
- Owner: ChuksJoshuaa
- Created: 2025-02-10T17:19:11.000Z (11 days ago)
- Default Branch: main
- Last Pushed: 2025-02-13T00:12:14.000Z (8 days ago)
- Last Synced: 2025-02-13T00:29:59.450Z (8 days ago)
- Topics: cypress, reactjs, redux-toolkit, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://news-aggregator-ck.netlify.app/
- Size: 151 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# News Aggregator
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](https://news-aggregator-ck.netlify.app/)
## 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**:
```bash
git clone https://github.com/ChuksJoshuaa/News-Aggregator.git
```
2. **Install the repository**:
```bash
npm install --force
```
3. **Build the repository with docker**:
```bash
docker-compose up --build
```
## Usage
To start the application and begin using project, follow these steps:
1. **Start the application**:
```bash
npm run dev
```
2. **Open your web browser** and navigate to
```bash
http://localhost:5173
```
## Running Tests
To run the Cypress end-to-end tests, use the following command:
```bash
npm run open:cypress
```
## Contributing
Contributions are welcome! To contribute to project, follow these steps:
1. **Fork the repository**.
2. **Create a new branch**:
```bash
git checkout -b feature/your-feature-name
```
3. **Make your changes and commit them**:
```bash
git commit -m 'Add some feature'
```
4. **Push to the branch**:
```bash
git push origin feature/your-feature-name
```
5. **Submit a pull request**.