Skip to content

uppnrise/user-unknown-news

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

To get the application running locally:

# 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:

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 file for details.

Acknowledgments

  • Thanks to the ok.surf API for providing news data.
  • Inspired by the need for a simple, yet informative news aggregator.

About

a simple news application for unknown users

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published