📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
  • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🔭 Acknowledgements
• ❓ FAQ
• 📝 License

🎯 News Feeder

This project is a News Feed application built using React.js and Tailwind CSS, leveraging a variety of modern technologies and features to deliver a dynamic and engaging user experience. The application fetches news data from a provided API and presents it to users in an intuitive and organized manner.

🛠 Built With

Tech Stack

Front-End	Dev Essentials	Tools
React Js	Eslint	VS Code
Tailwind CSS	Prettier	GIT, GITHUB

📌Key Features

Main functionalities which the app will have:

• Sleek UI with React.js and Tailwind CSS: Utilize React.js and Tailwind CSS to create a stylish and responsive user interface.
• API Integration for Fresh Content: Integrate a custom API to fetch up-to-date news articles.
• Effortless Category Filtering: Enable users to explore news by categories such as technology, sports, and entertainment.
• Quick Search Feature: Implement a search function for users to find news articles based on keywords or topics, with optimized performance.
• Flexible News Fetching: Use the useNewsQuery custom hook to fetch categorized and uncategorized news with ease.
• Responsive Design for Any Device: Ensure seamless user experience across all devices and screen sizes.

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

You have to those tools in your local machine.

• NodeJs
• Any Code Editor (VS Code, Brackets, etc)
• GIT & GITHUB

Clone Repo

Clone the project using the following bash command in an appropriate location.

  git clone https://github.com/kaiumuddin/news-feeder

Go to the project directory.

  cd news-feeder

Add necessary packages

For installing necessary packages, run the following bash command:

  npm install

Run the server in development mode

In the project directory, you can run the project by using following bash command:

  npm run dev

And now you can visit the site with the URL http://localhost:3000

(back to top)

👥 Authors

Kaium Uddin

(back to top)

🔭 Future Features

• Will added unit and integration testing using jest
• Will check real devices with different browsers to imprive responsive performance

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

👋 Show your support

Give a ⭐️ if you like this project!

(back to top)

🔭Acknowledgments

• My Family.
• Shahadat Hossain

(back to top)

❓ FAQ

• Can I use this project for personal use?

  • Yes, you can use it.

(back to top)

📝 License

This project is MIT licensed.

(back to top)