Skip to content

CoderMattGH/nc-news-fe

Repository files navigation

NC News Front-end Web Application

About

NC News is a social news aggregation, web content rating and discussion website. NC News has articles which are divided into topics, and each article has user-curated ratings from upvotes and downvotes using the API. Users can also add comments about an article.

You can use the application by visiting: https://nc-news.codermatt.com/

NC News API

The NC News front-end application interacts with the back-end NC News API, which can be found at: https://github.com/CoderMattGH/nc-news-be.

Running NC News Locally

Requirements

Node.js [minimum version 21.6.2]

Installation

  1. In your terminal, clone the NC News repository by executing:

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

  2. Next, enter the repository directory.

  3. To download all the necessary dependencies, run the command:

    npm install

Running

After following the installation instructions above, you should now be ready to run the application.

  1. Navigate to the repository directory in your terminal.

  2. Execute the following command:

    npm run dev

  3. This should start a local server where you can visit the application via your web browser. The URL will be provided in the output from the above command.

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