Skip to content

michael-farah/news-app

Repository files navigation

MF News

MF News Logo
MF News is a project designed to showcase the creation of a social news aggregation platform using simulated data. Users can explore, vote on, and discuss articles managed by a backend API, demonstrating core concepts of front-end and back-end interaction in web development.

🌍 Live Demos

Netlify Status Firebase Deploy

Check out the live versions of MF News, where you can browse and interact with sample articles:

📚 Overview

MF News serves as a comprehensive demonstration of a social news platform where users can:

  • 📰 Browse and Read: Access sample articles on a variety of topics.
  • 👍 Vote: Upvote or downvote articles based on your opinion.
  • 💬 Engage: Add comments and join discussions with other users.
  • 🔍 Explore: Discover topics curated by simulated community input.

This project offers a clear example of how a front-end client interacts with a backend API, demonstrating core concepts of front-end and back-end interaction in web development.

🚀 Getting Started

Prerequisites

  • Node.js: Ensure you have Node.js installed. The minimum required version is v21.7.3.

Installation

To run MF News locally, follow these steps:

  1. Clone the Repository

    git clone https://github.com/michael-farah/news-app.git
  2. Navigate to the Project Directory

    cd news-app
  3. Install Dependencies

    Use pnpm to install the project dependencies:

    pnpm install
  4. Start the Development Server

    pnpm run dev

Your local instance of MF News will be available at http://localhost:5173.

🔗 Backend Repository

MF News relies on a dedicated backend API. Explore the backend code and its implementation here:

News API Backend

📖 Project Insights

This project is part of a sprint set by NorthCoders focused on understanding the development of C.R.U.D (Create, Read, Update, Delete) applications. It illustrates the interaction between a front-end client and a backend API, with features that allow user engagement through content interaction and discussion.

💬 Feedback

Feedback is welcome! If you'd like to improve or add features to MF News, feel free to open an issue or submit a pull request.


Made with ❤️ by Michael Farah

About

Resources

Stars

Watchers

Forks