dhairya0907 / Hacker-News-API

Api usage and Design demonstration using Hacker News Api and React.

Hacker News API

Api usage and Design demonstration using Hacker News Api and React.

View Demo · Report Bug · Request Feature

 

About The Project

Mobile Version

Desktop Version

This project is demonstration of how to use API in React project and how to Design simple website using React. I have used Haker News free api fot this demonstration, You can use any other API in same way.

Here's why I use Hacker News API and React :

• I used Hacker News API because it's free to use and it updates in real time.
• I used React Library to develop and Design web application because it is easy to learn and easy to use.
• React has great developer tools.
• A virtual DOM is used.

Built With

• React
• Hacker News API
• Deployed using Vercel

What I learned

• How to use API in React.
• How to Design React web application.
• How Structure React web application source code.

Getting Started

To host web application on user localhost follow below steps :

Prerequisites

• yarn

  npm install --global yarn

Installation

1. Get a free API Key at https://github.com/HackerNews/API
2. Clone the repo

   git clone https://github.com/dhairya0907/Hacker-News-API.git

3. Install YARN packages

   yarn install

4. Run on localhost

   yarn start

Roadmap

See the open issues for a list of proposed features (and known issues).

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Dhairya Sharma - @dhairya_0907 - [e-mail]

Project Github Link: https://github.com/dhairya0907/Hacker-News-API

Project Web Application Link: https://hackernewsapi-demo.vercel.app/