Skip to content

Latest commit

 

History

History
68 lines (51 loc) · 1.67 KB

README.md

File metadata and controls

68 lines (51 loc) · 1.67 KB

News App

This project is a news platform built with React and TypeScript. It fetches news articles from an external API and displays them in a grid layout. Users can click on an article to read more details in a modal. The application is styled using Ant Design components, and tests are written using Jest and @testing-library/react.

Table of Contents

Features

  • Fetches news articles from an external API.
  • Displays articles in a responsive grid layout.
  • Users can click on an article to open a modal with more details.
  • Styled using Ant Design components.
  • Comprehensive tests written using Jest and @testing-library/react.

Installation

  1. Clone the repository:
    git clone https://github.com/yourusername/news-app.git
  2. Navigate to the project directory:
    cd news-app
  3. Install the dependencies:
    npm install

Usage

  1. Create a .env file in the root of the project and add your API key:
    REACT_APP_NEWS_API_KEY=your-api-key
  2. Start the development server:
    npm start
  3. Open your browser and navigate to http://localhost:3000.

Testing

To run the tests, use the following command: npm test

Technologies

  • React
  • TypeScript
  • Ant Design
  • Jest
  • @testing-library/react

Contributing

Contributions are welcome! Please fork the repository and create a pull request with your changes.

License

This project is licensed under the MIT License.