Skip to content

smlbrd/nc-news-frontend

Repository files navigation

NC News Web App

📖 Table of Contents

🦇 About

This React project has been created to allow users to interact with data in a dynamic and responsive web application.

It has been designed mobile-first to deliver a responsive experience across multiple devices, and it utilises reusable components and accessible design principles to ensure it can be used by the broadest range of users.

A hosted version of this project is available online here.

The backend API for this project can be viewed here.

Please be patient when clicking the links above, as they can take a minute or two to spin up for the first time!

🚀 Getting Started

These instructions will get a copy of this project running on your local machine for development and testing!

⛏️ Prerequisites

We need to create a clone of the repository, install some dependencies and set up our development environment.

This web app uses Node.js, so please ensure your installation meets the following minimum requirements:

- Node v22.8.0

🐏 Cloning this repository

Open your terminal, navigate to the directory where you'd like to copy this repo, and run the following command:

git clone https://github.com/smlbrd/wren-nc-frontend.git

⛓️ Installing dependencies

To run this API, we'll need to install some dependencies using the following terminal command:

npm install

🏃‍♀️ Hosting the app locally

You can host a version of this application locally using the following terminal command:

npm run dev

Follow the 'Local' link (e.g. by holding CTRL and left-clicking the localhost:5173 link) in the terminal.

That's it - you're good to go! Have fun, and thank so much for taking a look at my work! 🙌

🎉 Special Thanks

This project gratefully depends on the work of:


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

About

Web app for the 'NC News' API - a solo project from the Northcoders JavaScript Software Development bootcamp

Topics

Resources

Stars

Watchers

Forks