https://github.com/uppnrise/user-unknown-news
a simple news application for unknown users
https://github.com/uppnrise/user-unknown-news
news newsfeed newspapers
Last synced: 7 months ago
JSON representation
a simple news application for unknown users
- Host: GitHub
- URL: https://github.com/uppnrise/user-unknown-news
- Owner: uppnrise
- License: mit
- Created: 2024-01-20T12:44:21.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-04-05T15:53:58.000Z (7 months ago)
- Last Synced: 2025-04-05T16:33:46.026Z (7 months ago)
- Topics: news, newsfeed, newspapers
- Language: TypeScript
- Homepage: https://user-unknown-news.vercel.app
- Size: 242 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# User Unknown's News
## Description
The User Unknown's News is a modern, responsive web application built with React, showcasing the latest news across various categories. Utilizing an external news API, this application presents news items in an easy-to-navigate format, catering to users who wish to stay updated with current events in a fast and efficient manner.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Running the Tests](#running-the-tests)
- [Contributing](#contributing)
- [License](#license)
## Installation
To get the application running locally:
```bash
# Clone the repository
git clone https://github.com/uppnrise/user-unknown-news.git
# Go into the repository
cd user-unknown-news
# Install dependencies
npm install
# Start the application
npm start
```
## Usage
After starting the application, you can view the latest news articles categorized by different sections. Each section can be expanded to view more news items.
### Features
- **Categorized News**: News items are categorized for easier navigation.
- **Responsive Design**: Compatible with various screen sizes.
- **Dynamic Data Fetching**: News items are fetched in real-time from an API.
## Running the Tests
To run the automated tests for this system:
```bash
npm test
```
### Unit Tests
Unit tests are written for both the `App` and `NewsList` components to ensure they work as expected.
- `App` tests verify API integration and error handling.
- `NewsList` tests check the functionality of news item display and toggling.
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
## Acknowledgments
- Thanks to the [ok.surf](https://ok.surf/api/v1/cors/news-feed) API for providing news data.
- Inspired by the need for a simple, yet informative news aggregator.