Lee's News - Front End App 🗞

Portfolio Project - Front End

---

Built by: Lee Kirkham (2022 & 2023)

---

Front-End

• Try the application here: https://fe-nc-news-app.netlify.app/
• Front-End - Git-Hub Repo Link: https://github.com/leekli/nc-news-frontend

Back-End

• Back-End - Live API: https://lee-be-nc-news.onrender.com/api
• Back-End - Git-Hub Repo Link: https://github.com/leekli/nc-news-backend

Description

This is a front-end React application which connects to the backend API & database (link above) to aggregate news articles, topics, comments and users.

Built using React.js, and styled with the 'Ant Design' React UI framework.

There is a back-end API of this app available at: https://lee-be-nc-news.onrender.com/api

Demo video:

How to run this project locally

Minimum requirements:

• In order to run this project, please ensure you have Node installed, at least version v16.x onwards.

Clone the repo:

• In your teminal CLI:

$ git clone https://github.com/leekli/nc-news-frontend.git
$ cd nc-news-frontend

Install dependencies:

• Required dependencies will be pulled from the package.json file. In your teminal CLI:

$ npm install

Run the app:

• You can now run the app with the following command in the CLI, this will load the app in your Browser for you to use:

$ npm run dev

Docker

• This repo can be ran in a Docker container, a compose.yaml & Dockerfile are included in the root folder. Run the following command:

$ docker compose up