rob83uk / nc-news

NC News App ReadMe

This project was built during a coding bootcmap with Northcoders. It is a C.R.U.D. app built using React and making use of a back-end project here -

https://github.com/rob83uk/be-nc-news

The App is live hosted using Netlify, follow the link below.

https://keen-blackwell-c0fbba.netlify.app/

How to run this project locally

Fork the repo and clone by running the following command

git clone https://github.com/rob83uk/nc-news.git

CD into the directory.

Install the necessary dependencies by running the following command in the treminal

npm i

Then in the project directory, you can run the app in the development mode.:

npm start

Open http://localhost:3000 to view it in the browser.

User Stories

Below is a selection of User Stories I have followed while building the App.

As a user, I should be able to...

view a list of all articles

view a page for each topic with a list of related articles.

view an individual article.

view an individual article's comments.

vote on an article and immediately see the change.

change user to simulate a new user loggin in.

post a new comment to an existing article (as a default logged in user. e.g. 'jessjelly').

delete my own comments (as a default logged in user. e.g. 'jessjelly').

vote on a comment and immediately see the change.

navigate over pages of articles (e.g. using pagination or infinite scroll).

navigate over pages of comments (e.g. using pagination or infinite scroll).

use the site on my mobile without sacrificing style or functionality Error-handling: As a user, I should... see an appropriate error if I go on a non-existent path / a path for a non-existent article / topic.

not be allowed to post a comment if I have not filled in all of the form boxes.

Minimum Software Versions

Node - 14.17.4 Postgress 13.3