An open API service indexing awesome lists of open source software.

https://github.com/ttibbs/nc-news

Full stack news aggregate app created as part of a Digital Skills Bootcamp in Software Engineering provided by Northcoders.
https://github.com/ttibbs/nc-news

axios context crud-operation error-handling form-validation javascript react react-hooks react-router realtime-database restful-api state-management vite

Last synced: 3 months ago
JSON representation

Full stack news aggregate app created as part of a Digital Skills Bootcamp in Software Engineering provided by Northcoders.

Awesome Lists containing this project

README

          



Typing SVG

# NC News FE Project

Welcome to N(c)ews! This is a React app built with Vite.js to display news articles from a backend server. It was created as part of the frontend phase of the Northcoders bootcamp.

## Table of Contents

- [Live View](#live-view)
- [About The App](#about-the-app)
- [Tech Stack](#tech-stack)
- [Screenshots](#screenshots)
- [Backend Repo](#backend-repo)
- [Requirements](#requirements)
- [Installation](#installation)

## Live View

View the live version [here](https://nc-news-ten.vercel.app/)

## Features to Explore:

- Browse articles by topic.
- Read detailed articles.
- Post comments and vote on articles.
- Sign up and log in to interact with content (e.g., post or delete comments and articles).

## About the App

NC News is a news aggregation and interaction app where users can:

- Browse news articles by topic.
- Read individual articles with detailed views.
- Post comments on articles and interact via voting.
- Create an account and log in for enhanced functionality (e.g., posting or deleting articles/comments).

This project was designed to practice frontend development principles, including routing, API integration, and dynamic user interfaces.

## Tech Stack


vite-js
javascript
Tailwind CSS
visual-studio-code-2019
git



Screenshots



Mobile


Auth screen displayed on a iPhone 14 Pro Max
Articles screen displayed on a iPhone 14 Pro Max
Single article screen displayed on a iPhone 14 Pro Max
Topics screen displayed on a iPhone 14 Pro Max
Topic slug screen displayed on a iPhone 14 Pro Max


Tablet


Auth screen displayed on a iPad Pro 11
Articles screen displayed on a iPad Pro 11
Single article screen displayed on a iPad Pro 11
Topics screen displayed on a iPad Pro 11
Topic slug screen displayed on a iPad Pro 11


Laptop


Auth screen displayed on a MacBook Pro
Articles screen displayed on a MacBook Pro
Single article screen displayed on a MacBook Pro
Topics screen displayed on a MacBook Pro
Topic slug screen displayed on a MacBook Pro

## Backend Repo

If you are interested in viewing the backend repo and investigating the server, you can go [here](https://github.com/TTibbs/be-nc-news)
And if you are interested in viewing the API endpoints you can see them [here](https://be-nc-news-92aj.onrender.com/api)

## Requirements

### Node Version

To run this project, you need Node.js v22.5.1 or higher.
To check your version of Node, open your terminal and use the following command:

```bash
node --version
```

## Installation

Follow these steps to set up the project on your machine:

### 1. Clone the Repository

```bash
git clone https://github.com/your-username/nc-news.git
```

### 2. Navigate to the Project Directory

```bash
cd nc-news
```

### 3. Install Dependencies

```bash
npm install
```

### 4. Start the Development Server

```bash
npm run dev
```

The app should now be running on http://localhost:5173 by default

---

This portfolio project was created as part of a Digital Skills Bootcamp in Software Engineering provided by [Northcoders](https://northcoders.com/)