Giter Club home page Giter Club logo

nc-news-frontend's Introduction

Lee's News - Front End App ๐Ÿ—ž

Portfolio Project - Front End


Built by: Lee Kirkham (2022 & 2023)


Front-End

Back-End

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

nc-news-frontend's People

Stargazers

Roman avatar

Watchers

Lee ๆŽ avatar

Forkers

oscarjames24

nc-news-frontend's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.