Skip to content

MaddieAnita/nc-news-frontend

Repository files navigation

Northcoders News API

Welcome to my React NC News website!
This project was built in two phases:

The Backend:

Over 4 days, we were tasked with building a working API that would eventually be used by our frontend to display data.
To see a demo of the working API, follow the link:

https://nc-news-api-e143.onrender.com/api

This will give you all the available endpoints for this API

The FrontEnd:

Over 4.5 days, we were tasked to used React to build a working frontend application. This website is a news web application, it has various capabilities which are listed below.
To visit this website, follow the link:

https://nc-news-mm.netlify.app/

FrontEnd Technology Stack

This NC News Website is using the following technologies:

  • React JS
  • React Icons
  • Axios
  • React Router

Core Features

This application does not user any Authentication and therefore users can be manually selected to change 'user' profiles through the Users menu option.

Header:

  • Includes categories in a sub menu of Topics

Home:

  • View categories, featured articles, all articles including pagination
  • Users can sort all articles by Sort By, Order and Featured

Single Article:

  • Brings back all information for that article
  • Users can vote positively or negatively on article
  • Lists all comments related to article including pagination
  • Users can post new comment
  • Includes error and success handling for user feedback

Single Topic:

  • lists all article within that topic including pagination
  • Users can sort all articles by Sort By, Order and Featured
  • Includes error and success handling for user feedback

Get Started

To get started with this project, follow these steps:

Installation

Clone this repository:

git clone https://github.com/your-username/nc-news-frontend.git

Navigate to the project directory on your local machine:

cd nc-news-frontend

Open the project using your preferred IDE. Open a terminal in your IDE and run the following command to install packages required:

npm install

Finally, to run the app run:

npm run dev

Minimum versions needed to run this application:

Node.js - 18.0.0

This portfolio project was created as part of a Digital Skills Bootcamp in Software Engineering provided by Northcoders

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published