Here is the updated README file with instructions on how to download from the GitHub repository and run locally:

News Headlines Project

==========================

A Next.js project that displays the latest news headlines from around the world.

Getting Started


To get started with this project, follow these steps:

Prerequisites

  • Node.js (version 14 or higher)
  • npm (version 6 or higher)
  • yarn (optional)
  • Git (for cloning the repository)

Installation

  1. Clone the repository: Open a terminal and run the following command to clone the repository:
git clone https://github.com/willeynimbus/news-headlines.git
  1. Change into the project directory: Navigate into the cloned repository:
cd news-headlines
  1. Install dependencies: Install the required dependencies:
npm install

or

yarn install
  1. Start the development server: Start the development server:
npm run dev

or

yarn dev
  1. Open the application: Open a web browser and navigate to http://localhost:3000 to see the application in action.

API Key

This project uses the News API to fetch headlines. You'll need to obtain an API key from News API and add it to the fetch URL in components/Headlines.tsx.

Features


  • Displays the latest news headlines from around the world
  • Fetches data from the News API
  • Error handling for API requests
  • Responsive design using Tailwind CSS

Technologies Used


  • Next.js (version 14)
  • React (version 18)
  • Tailwind CSS (version 3)
  • News API

File Structure


  • components: React components for the project
  • lib: Utility functions and helpers
  • app: Next.js pages and layouts
  • public: Static assets and images
  • tailwind.config.ts: Tailwind CSS configuration
  • postcss.config.mjs: PostCSS configuration

Contributing


Contributions are welcome! If you'd like to contribute to this project, please fork the repository and submit a pull request.

License


This project is licensed under the MIT License. See LICENSE for details.

Acknowledgments


  • News API for providing the news data
  • Next.js and React for making this project possible
  • Tailwind CSS for the styling and layout