https://github.com/funmilolajire/redditclient

a web app built on reddit's api
https://github.com/funmilolajire/redditclient

circle-ci enzyme jest netlify react reddit-api reddit-client redux redux-toolkit scss tailwindcss typescript

Last synced: 7 months ago
JSON representation

a web app built on reddit's api

• Host: GitHub
• URL: https://github.com/funmilolajire/redditclient
• Owner: funmilolajire
• License: mit
• Created: 2020-12-03T18:53:56.000Z (almost 5 years ago)
• Default Branch: development
• Last Pushed: 2021-04-05T23:22:31.000Z (over 4 years ago)
• Last Synced: 2025-02-02T01:43:28.342Z (8 months ago)
• Topics: circle-ci, enzyme, jest, netlify, react, reddit-api, reddit-client, redux, redux-toolkit, scss, tailwindcss, typescript
• Language: HTML
• Homepage: https://redditclient.netlify.app/
• Size: 1.85 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Reddit Client  



[![Netlify Status](https://api.netlify.com/api/v1/badges/8e0a7204-8850-4b4a-9340-01317eaabc56/deploy-status)](https://app.netlify.com/sites/redditclient/deploys)

[![CircleCI](https://circleci.com/gh/funmilolajire/redditclient.svg?style=svg)](https://circleci.com/gh/funmilolajire/redditclient)

[![GitHub Issues](https://img.shields.io/github/issues/funmilolajire/redditclient.svg)](https://github.com/funmilolajire/redditclient/issues)

[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/funmilolajire/redditclient.svg)](https://github.com/funmilolajire/redditclient/pulls)

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)



> This is a web application that retrieves data from reddit using it's api and allows users to view and search posts and comments provided by the api.

## Table of contents  

- [General info](#general-info)

- [Screenshots](#screenshots)

- [Technologies](#technologies)

- [Setup](#setup)

- [Features](#features)

- [Status](#status)

- [Inspiration](#inspiration)

- [Contact](#contact)

## General info  

This project is built on reddit's api, user's are able to see an initial view when first visiting the site, they can search for posts using terms, can filter the results based on predefined categories and view comments under each post. It is responsive and can be used on any modern browser.

## Screenshots  

![mainScreenshot](./public/screenshots/RedditClient.png)

![modalScreenshot](./public/screenshots/RedditClientModal.png)

## Technologies  

- React - version 17.0.1  

- ReduxJS/Toolkit - version 1.5.0

- TailwindCSS - version 2.0.3

- TypeScript - version 4.0.3

- GSAP - version 3.6.0

- Node Sass - version 5.0.0

- VideoJS - version 7.11.4

- Enzyme - version 3.11.0

- DayJS - version 1.10.4

- HTML React Parser - version 1.2.4

- React Icons - version 4.2.0

## Setup  

Visit [redditclient](https://redditclient.netlify.app) i your browser.

## Features  

- Application can be used on any device

- Application can be used on any modern browser

- Shows an initial view of data to user on first visit

- Users can search data using terms

- Users can filter data based on predefined categories

- Users are shown a detail view when they select an item

- Users are able to leave an error state

- Application is a progressive web app

## Status  

Project is: _finished_

## Inspiration  

This project is inspired by a portfolio project on [codecademy's](https://www.codecademy.com/paths/full-stack-engineer-career-path) full stack engineer career path.

## Contact  

Created by [@funmilolajire](mailto:funmilolajire@gmail.com) - feel free to contact me!