Skip to content

MZHoffman/GoodNewsPortal

Repository files navigation

🌈 Good News Portal 📰

Welcome to the Good News Portal! This is a web application that allows you to read articles, post comments, vote for articles, sort through articles, and filter them by topic. You can check out the deployed version of the site here.

Technologies Used 💻

This project utilizes the following technologies:

  • Frontend:

    • React ⚛️
    • React Router 🛤️
    • Material-UI (MUI) 🔧
    • Axios for API requests 🌐
  • Backend:

    • Node.js 🚀
    • Express.js ⚡️
    • PostgreSQL (Database) 🐘
    • Jest and Supertest for testing 🧪

🐑 Clone and Install 📦

To run this project locally, follow these steps:

  1. Start by setting up the backend API. You can find the API repository here. Follow the instructions in its README to get the API up and running on http://localhost:9090/api.

  2. Next, clone this repository and navigate to the local folder:

    git clone https://github.com/MZHoffman/GoodNewsPortal

    cd GoodNewsPortal

  3. Install the project dependencies: npm install

  4. Start the development server: npm run dev

  5. After running the above command, you will see a link provided in your terminal. Open this link in your web browser to access the Good News Portal locally. 🌐

Enjoy exploring the world of good news! 🌈😄

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published