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.
- Host: GitHub
- URL: https://github.com/ibizugbe/blog-post-viewer
- Owner: Ibizugbe
- Created: 2024-07-16T18:41:55.000Z (about 1 year ago)
- Default Branch: dev
- Last Pushed: 2024-07-19T14:23:36.000Z (about 1 year ago)
- Last Synced: 2025-05-07T14:56:32.309Z (5 months ago)
- Language: TypeScript
- Size: 930 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
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** 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.
Client
Style
API
- **API interaction**
- **Render all posts**
- **See details of a post**
- **Infinite scroll**
- **Darkmode**
- **Responsive UI**
- [Live Demo Link](https://dev--blog-post-viewer01.netlify.app/)
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πΎ.
π€ **Abraham Ibizugbe**
- GitHub: [@githubhandle](https://github.com/ibizugbe)
- LinkedIn: [LinkedIn](https://linkedin.com/in/abrahamibizugbe)
- [ ] **User Authentication**
- [ ] **Favorite post recommendation**
- [ ] More performance improvement
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project, you can give it a βοΈπ«
I would like to thank the developers of the JSON placeholder API.
This project is [MIT](./MIT.md) licensed.