/fe-nc-news-project

๐Ÿ“ฐ A social news aggregator app built with React [Northcoders front-end portfolio project]

Primary LanguageJavaScript

๐Ÿ—ž๏ธ My News Aggregator App ๐Ÿ—ž๏ธ

Hello! ๐Ÿ‘‹ Welcome to my news aggregator app - NC News.

Click here to visit and explore the app.

๐Ÿ’ญ Description

This is my front-end project that uses my news API built in the back-end phase of the Northcoders bootcamp.

๐Ÿค” What Does It Do?

Making calls to the API, the app allows the user the following functionality:

  • ๐Ÿ—ž๏ธ Access a list of all articles
  • ๐Ÿšฆ Filter articles by topic
  • ๐Ÿ“‘ Sort articles by: date, comment count and votes
  • โฌ†๏ธโฌ‡๏ธ List sorted articles in ascending or descending order
  • ๐Ÿ“„ View a single article
  • ๐Ÿงต View comments relating to a given article
  • ๐Ÿ’ฌ Post comments
  • ๐Ÿ—‘๏ธ Delete user comment

๐Ÿ–ฅ๏ธ Running the App Locally

๐Ÿšง Before beginning setup, please check you have at least these versions of the following:

  • node - v. 17.5.0

After doing so, perform each step, in order:

๐Ÿ’ป โžก๏ธ ๐Ÿ’ป Cloning the repository

git clone https://github.com/davidptclark/fe-nc-news-project

๐Ÿ—๏ธ Install required packages

Simply run npm install to install the necessary dependencies required.

๐Ÿ–ฅ๏ธ Building and running the site

To build and run the site on your local machine, run npm start.