Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johnimril/news-app
This news platform fetches articles from an external API and displays them in a grid layout. Tests are written with Jest and @testing-library/react.
https://github.com/johnimril/news-app
jest react testing-library typescript
Last synced: 1 day ago
JSON representation
This news platform fetches articles from an external API and displays them in a grid layout. Tests are written with Jest and @testing-library/react.
- Host: GitHub
- URL: https://github.com/johnimril/news-app
- Owner: JohnImril
- Created: 2024-07-30T21:22:38.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-07-30T21:30:23.000Z (4 months ago)
- Last Synced: 2024-07-31T01:42:55.045Z (4 months ago)
- Topics: jest, react, testing-library, typescript
- Language: TypeScript
- Homepage:
- Size: 259 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Testing](#testing)
- [Technologies](#technologies)
- [Contributing](#contributing)
- [License](#license)
## 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:
```sh
git clone https://github.com/yourusername/news-app.git
```
2. Navigate to the project directory:
```sh
cd news-app
```
3. Install the dependencies:
```sh
npm install
```
## Usage
1. Create a `.env` file in the root of the project and add your API key:
```env
REACT_APP_NEWS_API_KEY=your-api-key
```
2. Start the development server:
```sh
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.