Project Overview:
This project is a full-stack web application that allows users to browse a list of articles, filter articles by topics, comment count, votes and newly posted, view individual pages for each article, vote on articles, post comments on articles, and delete their own comments. Future features to be added.
Technology Stack:
Front-end: React.js, React Router, Axios, Cypress, CSS for styling. Back-end: Node.js, Express.js, PostgreSQL for the database, Jest and Supertest. API: RESTful API with endpoints for retrieving articles, topics, comments, posting comments, voting, and deleting comments.
A hosted version of the project can be found at the link below. You can try it out by visiting the website and exploring its features. As I am using a render free tier it may take a moment to load.
https://luminous-druid-1cc7bd.netlify.app/
https://github.com/DamianMacG/NC-News-Backend
Running the Project Locally -
Clone the Repository:
git clone https://github.com/DamianMacG/nc-news.git
Open a terminal and navigate to the root directory of the frontend project:
cd nc-news
Install the necessary dependencies:
npm install
Start the frontend development server:
npm run dev
Access the App:
Open your web browser and navigate to http://localhost:5173 to access the local version of the application.
The minimum version required for running this project are:
Node.js: v14 or higher