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.
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 🧪
To run this project locally, follow these steps:
-
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
. -
Next, clone this repository and navigate to the local folder:
git clone https://github.com/MZHoffman/GoodNewsPortal
cd GoodNewsPortal
-
Install the project dependencies:
npm install
-
Start the development server:
npm run dev
-
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. 🌐