Transforming Data into News 🚀

About the Project 📄

This is a React project that aims to transform data into news. It uses the IBGE news API to create a page that displays the most recent news in an organized and intuitive manner.

Features 💡

• Recent News: Displays the most recent news from IBGE.
• Access to Full News: Each news item in the list can be clicked to access the complete news article.
• Favorites: Users can mark their favorite news for easy access in the future.
• Filters: Users can filter news by type, favorites, and title.

Technologies Used 🛠️

This project was developed using the following technologies:

• React

• TypeScript

• Context API

• Custom Hooks

• React testing library

• Vitest

• Styled components

• Docker

How to Run the Project 🚀

Run project locally

⚠️ You must have Node installed on your machine.

1. Clone the repository:

git clone git@github.com:mairess/trybe-news.git

2. Install dependencies:

npm install

3. Start the server:

npm run dev

4. The server will be available on port 3000

Run project with docker

⚠️ You must have Docker installed on your machine.

1. Clone the repository:

git clone git@github.com:mairess/trybe-news.git

2. Up the container:

docker compose up -d

4. The server will be available on port 3000

Run tests

Run all tests

npm run test

Run coverage

npm run coverage

Contributions 💡

Contributions are always welcome! Feel free to open an issue or submit a pull request.

License 📝

This project is licensed under the MIT License. You can read the file here.