README.md

✨ Welcome to QuickRead.news ✨

About • Features • Tech Stack • Getting Started • Contributing • License • Acknowledgements

🚀 About

Stay updated with breaking news and top stories in under 60 words. Perfect for busy lives! 🚀

🌟 Key Features

• Real-time News Updates: Get the latest headlines as they break.
• Customizable News Feed: Tailor your news experience to your interests.
• Multi-source Aggregation: Access news from a wide range of reputable sources.
• Responsive Design: Enjoy a consistent experience across all devices.
• User-friendly Interface: Navigate through news effortlessly with our intuitive design.

🛠️ Tech Stack

Detailed Breakdown:

Frontend

• React: For building a dynamic and responsive user interface
• Next.js: For server-side rendering and optimized performance
• TailwindCSS: For rapid and customizable styling
• Vite: For fast development and building

Backend

• Node.js: For server-side logic
• Express: For creating robust API endpoints
• Nodemon: For automatic server restarts during development

Version Control

• Git: For source code management
• GitHub: For collaborative development and issue tracking

Hosting

• Vercel: For seamless deployment and scaling

Development Tools

• VS Code: As the primary code editor
• GitHub Desktop: For simplified Git operations

🚀 Getting Started

These instructions will help you set up the project on your local machine for development and testing purposes.

Prerequisites

• Node.js and npm installed on your machine
• A NewsAPI.org API key

Installation

1. Fork the repository on GitHub.
2. Clone the repository to your local machine:

   git clone https://github.com/yourusername/QuickRead.news.git

3. Navigate to the server directory and create a new file named .env:

   cd QuickRead.news/Server
   touch .env

4. Add your NewsAPI.org API key to the .env file:

   API_KEY=your_news_api_key
   

5. Install server dependencies and start the server:

   npm install
   node index.js

6. In a new terminal, navigate to the client directory, install dependencies, and start the client:

   cd ../Client
   npm install
   npm run dev

Usage

Once the project is set up and running, you can view news articles from various sources on the client side. Open your browser and navigate to http://localhost:5174 to start exploring QuickRead.news!

🤝 Contributing

We welcome contributions! Please see our Contributing Guidelines for more details.

📄 License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.

🙏 Acknowledgements

• Thanks to all the open-source libraries and tools that made this project possible.