Skip to content

CWDamm/nc-news

Repository files navigation

README

Description

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

As part of the back-end phase of the bootcamp, I built an API using news article data provided by Northcoders. For more details of this initial project, see https://github.com/CWDamm/be-nc-news

For the front end phase, I developed this single page app using React and Vue, making requests to the existing API endpoints. A version hosted with Netlify is available at https://nc-news-cwdamm.netlify.app/

The home page provides a list of all articles showing the headline, images, number of votes and number of comments. Articles can be sorted by a range of parameters and there are separate pages for different topics.

Users are able to log-in using the username provided on the log-in page, or as any of the users shown on https://be-nc-news-cwdamm.onrender.com/api/users

Each article also has it's own page, where you can up or down-vote the article, and if logged in, make a comment.

Dependencies

This project was created using node As of version 0.0.0, the following project dependencies and versions were used:

  • axios: ^1.7.2
  • ldrs: ^1.0.2
  • react: ^18.2.0
  • react-dom: ^18.2.0
  • react-icons: ^5.2.1
  • react-router-dom: ^6.23.1

The following developer dependencies were also used:

  • @types/react: ^18.2.66
  • @types/react-dom: ^18.2.22
  • @vitejs/plugin-react: ^4.2.1
  • eslint: ^8.57.0
  • eslint-plugin-react: ^7.34.1
  • eslint-plugin-react-hooks: ^4.6.0
  • eslint-plugin-react-refresh: ^0.4.6
  • vite: ^5.2.0

Getting started

To get a local copy up and running, follow these simple steps.

Clone the repo

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

Install NPM packages

npm install

Deploy the app locally

npm run dev

Licence

CC BY-SA 4.0

Creative Commons Attribution-ShareAlike 4.0 International

This license requires that reusers give credit to the creator. It allows reusers to distribute, remix, adapt, and build upon the material in any medium or format, even for commercial purposes. If others remix, adapt, or build upon the material, they must license the modified material under identical terms.

See the License Deed

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published