https://github.com/simonapiz/projectredditclient
Application that allow users to view and search posts and comments provided by the Reddit API
https://github.com/simonapiz/projectredditclient
api-rest codecademy-solutions front-end-development html-css http-requests javascript react-router reactjs reddit-api redux
Last synced: 2 months ago
JSON representation
Application that allow users to view and search posts and comments provided by the Reddit API
- Host: GitHub
- URL: https://github.com/simonapiz/projectredditclient
- Owner: SimonaPiz
- Created: 2022-05-17T14:11:29.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-26T06:56:59.000Z (over 2 years ago)
- Last Synced: 2025-02-13T06:23:37.656Z (over 1 year ago)
- Topics: api-rest, codecademy-solutions, front-end-development, html-css, http-requests, javascript, react-router, reactjs, reddit-api, redux
- Language: JavaScript
- Homepage: https://reddit-client_simonapiz.surge.sh/
- Size: 1.01 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# App Reddit Client
> The application allow users to view and search posts and comments provided by the Reddit API.
Live demo [https://reddit-client_simonapiz.surge.sh/](https://reddit-client_simonapiz.surge.sh/).
## Screenshots
#### Preview Homepage
#### Preview Subreddit' page
## Table of Contents
* [General Info](#general-information)
* [Technologies Used](#technologies-used)
* [Features](#features)
* [Screenshots](#screenshots)
* [Wireframes](#wireframes)
* [Setup](#setup)
* [Acknowledgements](#acknowledgements)
## General Information
Reddit is a website where people share links to articles, media and other things on the web. I use [Reddit's API](https://github.com/reddit-archive/reddit/wiki/JSON) to provide data to integrate into the application. The application will allow users to view and search posts and comments provided by the API.
## Technologies Used
- react: 18
- react-redux: 8
- redux: 4
- node: 18
## Features
- [x] Users can use the application on any device (desktop to mobile)
- [x] Users can use the application on any modern browser
- [x] Users can access your application at a URL
- [x] Users see an initial view of the data when first visiting the app
- [x] Users can search the data using terms
- [x] Users can filter the data based on categories that are predefined
- [x] Users are shown a detailed view (modal or new page/route) when they select an item
- [x] Users are delighted with a cohesive design system
- [ ] Users are delighted with animations and transitions
- [ ] Users are able to leave an error state
- [ ] Get 90+ scores on Lighthouse
- We understand you cannot control how media assets like videos and images are sent to the client. It is okay to have a score below 90 for Performance if they are related to the media from Reddit.
- [ ] OPTIONAL: Get a custom domain name and use it for your application
- [ ] OPTIONAL: Set up a CI/CD workflow to automatically deploy your application when the master branch in the repository changes
- [ ] OPTIONAL: Make your application a progressive web app
## Wireframes
> Draft
> Desktop Homepage - low fidelity - with [figma](https://www.figma.com/)
> Desktop Post detail page - low fidelity - with [figma](https://www.figma.com/)
> React Component Hierarchy - Homepage
## Setup
To run this project, install it locally using npm:
```
$ cd ../[directory]
$ npm install
$ npm start
```
## Acknowledgements
This project comes from the [Codecademy's Front-End Engineer](https://join.codecademy.com/learn/paths/front-end-engineer-career-path-b/) course.