An open API service indexing awesome lists of open source software.

https://github.com/ibizugbe/blog-post-viewer

This is a web application that fetches and displays blog posts from the JSONPlaceholder API. Users can view a list of blog post titles and click on a title to see the full content of the selected blog post.
https://github.com/ibizugbe/blog-post-viewer

Last synced: 3 months ago
JSON representation

This is a web application that fetches and displays blog posts from the JSONPlaceholder API. Users can view a list of blog post titles and click on a title to see the full content of the selected blog post.

Awesome Lists containing this project

README

          




Blog Post Viewer

# πŸ“— Table of Contents

- [πŸ“– About the Project](#about-project)
- [πŸ›  Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [πŸš€ Live Demo](#live-demo)
- [πŸ’» Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [πŸ‘₯ Authors](#authors)
- [πŸ”­ Future Features](#future-features)
- [🀝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [πŸ™ Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [πŸ“ License](#license)

# πŸ“– Blog Post Viewer

**Blog Post Viewer** is a web application that fetches and displays blog posts from the JSONPlaceholder API. Users can view a list of blog post titles and click on a title to see the full content of the selected blog post.

## πŸ›  Built With

### Tech Stack

Client

Style


API

### Key Features

- **API interaction**
- **Render all posts**
- **See details of a post**
- **Infinite scroll**
- **Darkmode**
- **Responsive UI**

(back to top)

## πŸš€ Live Demo

- [Live Demo Link](https://dev--blog-post-viewer01.netlify.app/)

(back to top)

## πŸ’» Getting Started

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:

- Node JS.
- Any code editor of your choice.

### Setup

You can clone this repository to your desired folder using the command below.

```
git clone https://github.com/Ibizugbe/blog-post-viewer

cd blog-post-viewer
```

### Install

Run the command below to install the dependencies of this project.
```
npm install
```

### Usage

To run the project on your local server, execute the following command:

```
npm run dev
```

### Run tests

To run tests, run the following command:

```
npm test
```

### Deployment

The project has been deployed using NetlifyπŸ‘Ύ.

(back to top)

## πŸ‘₯ Authors

πŸ‘€ **Abraham Ibizugbe**

- GitHub: [@githubhandle](https://github.com/ibizugbe)
- LinkedIn: [LinkedIn](https://linkedin.com/in/abrahamibizugbe)

(back to top)

## πŸ”­ Future Features

- [ ] **User Authentication**
- [ ] **Favorite post recommendation**
- [ ] More performance improvement

(back to top)

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project, you can give it a β­οΈπŸ’«

(back to top)

## πŸ™ Acknowledgments

I would like to thank the developers of the JSON placeholder API.

(back to top)

## πŸ“ License

This project is [MIT](./MIT.md) licensed.

(back to top)