Article Hub

Article Hub is a platform that allows users to read, and engage with a variety of articles.


View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Mobile Screenshot
   • Desktop Screenshot
   • Built With
   • Deployed with
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap

About The Project

Article Hub is a simple, evolving project created to apply and showcase my skills as a Trainee Full Stack Developer. It's a platform centred around articles, facilitating reading and user interaction.

This project is part of my portfolio whilst enrolled on the Northcoders Software Development Bootcamp.

Mobile Screenshot

Desktop Screenshot

(back to top)

Built With

API: A custom API created for serving articles and related functionalities. It can be found here.

Deployed with

(back to top)

Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

Node.js

Installation

1. Clone the repo

   git clone https://github.com/RGBlife/news-api-ui.git

2. Navigate to the project directory

   cd news-api-ui

3. Install NPM packages

   npm install

4. Run the application

   npm run dev

   The application should now be running on localhost:3000 or another port if you have configured it differently.

(back to top)

Roadmap

• Caching requests to avoid unnecessary network calls
• Implement Light/Dark mode toggle
• Enhancements to the article page and comments section
• Implement infinite scrolling in the comments section
• Add user login/profile functionalities, including avatar uploads
• Develop features for adding articles and topics
• Enhancements to the topics dropdown for a more intuitive user experience
• Implement a global loading/error state using context for improved user feedback

For a more detailed plan, please refer to the project’s to-do list.

(back to top)