Skip to content

OpaogunProsper/fe-nc-news

Repository files navigation

NC News - Frontend 📔

NC News Deployed Version

Overview

NC news is a web-based application that provides users with the latest news articles on topics such as coding, cooking, and football. The front end is built using React.js and styled with Tailwind CSS and Chakra UI, which interacts with a RESTful backend API to fetch and display news articles.

Features

  • Responsive Design: Fully responsive and optimized for mobile, tablet and desktop devices
  • News Categories: Browse new articles by category (e.g. Coding, Football, Cooking) - Coming Soon!
  • Posting Comments: Express yourself by posting comments on your preferred article
  • Categorize and Filter Articles: Filter articles based on the date, time created, votes and comments
  • Sign In & Sign Out: Sign in with a username and name, these are the available names and usernames respectively: tickle122|Tom Tickle, grumpy19|Paul Grump, happyamy2016|Amy Happy, cooljmessy|Paul Messy, weegembump|Gemma Bump, jessjelly|Jess Jelly.

Back-End Repo

GitHub Repo

Minimum Requirements

  • Node.js version: >= 16.0.0
  • Package Manager: npm

Technologies Used

  • React.js
  • Axios
  • React router
  • CSS

Installation and Setup

Ensure you have the following installed:

  • Node.js(v14 or higher)
  • npm (Node Package Manager)

Steps to Run on your local machine

  1. Clone the repository: git clone https://github.com/OpaogunProsper/fe-nc-news.git
  2. Change your directory into the cloned repo: cd fe-nc-news
  3. Install dependencies: npm install
  4. Runs the app in development mode: npm run dev
  5. Open your browser and go to http://localhost:5173

Contributing

To contribute:

  1. Fork the project
  2. Create your feature branch: git checkout -b feature
  3. Commit your changes: git commit -m 'Added some amazing features'
  4. Push to the branch: git push origin feature
  5. Open a pull request

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

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published