https://github.com/dhairya0907/hacker-news-api
Api usage and Design demonstration using Hacker News Api and React.
https://github.com/dhairya0907/hacker-news-api
api design hackernews-api react reactjs
Last synced: 7 months ago
JSON representation
Api usage and Design demonstration using Hacker News Api and React.
- Host: GitHub
- URL: https://github.com/dhairya0907/hacker-news-api
- Owner: dhairya0907
- License: mit
- Created: 2021-04-30T15:22:33.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-07-24T15:09:47.000Z (about 4 years ago)
- Last Synced: 2025-01-25T05:26:57.109Z (9 months ago)
- Topics: api, design, hackernews-api, react, reactjs
- Language: JavaScript
- Homepage: https://hackernewsapi-demo.vercel.app/
- Size: 4.39 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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](https://reactjs.org/)
* [Hacker News API](https://github.com/HackerNews/API)
* [Deployed using Vercel](https://vercel.com/)
### 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
```sh
npm install --global yarn
```
### Installation
1. Get a free API Key at [https://github.com/HackerNews/API](https://github.com/HackerNews/API)
2. Clone the repo
```sh
git clone https://github.com/dhairya0907/Hacker-News-API.git
```
3. Install YARN packages
```sh
yarn install
```
4. Run on localhost
```sh
yarn start
```
## Roadmap
See the [open issues](https://github.com/dhairya0907/Hacker-News-API/issues) for a list of proposed features (and known issues).
## License
Distributed under the MIT License. See [`LICENSE`](https://github.com/dhairya0907/Hacker-News-API/blob/main/LICENSE) for more information.
## Contact
Dhairya Sharma - [@dhairya_0907](https://twitter.com/dhairya_0907) - dhairya.sharma532@gmail.com.com
Project Github Link: [https://github.com/dhairya0907/Hacker-News-API](https://github.com/dhairya0907/Hacker-News-API)
Project Web Application Link: [https://hackernewsapi-demo.vercel.app/](https://hackernewsapi-demo.vercel.app/)