README.md

NorthCoders News App

This is a mock News web application built with:

• React
• React Bootstrap
• Node.js
• Vite
• Axios
• HTML
• CSS
• JavaScript

It allows users to browse news articles, view individual articles, vote on articles, post comments, delete comments, and vote on those comments.

Links to live sites

• Live App: https://northcoders-news-kh.netlify.app
• API: https://northcoders-news-iumv.onrender.com/api
• Backend repo: https://github.com/KelH83/backend-project-nc_news

For the live site please use one of the following usernames to log in and vote/post comments etc:

tickle122

weegembump

grumpy19

happyamy2016

cooljmessy

jessjelly

The password is not functional(yet) so you can enter anything

Features

• News Article Retrieval: The app fetches news articles from a the API.
• View Single Article: Users can view a detailed page for each news article.
• Article Voting: Users can vote on articles to express their opinions.
• Commenting System: Users can post comments on articles and delete a comment they made
• Comment Voting: Users can vote on comments posted by other users.
• Filtering by Topic: Users can filter articles by topic.
• Sorting: Articles can be sorted by date, comments, or votes.

Installation

Minimum node version required: 21.1.0 or above

To run this project locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/KelH83/nc_news.git

2. Navigate into the project directory:

   cd nc_news

3. Install dependencies:

   npm install

4. Start the server:

   npm run dev

Contributing and contact

Contributions are welcome! If you find any bugs or have suggestions for improvements, please get in touch!

Email: Kellyhowes83@gmail.com

Have fun coding! 💻