bwalshin/reddit-minimal

The project was a task given by Codecademy being a part of their full-stack engineer course path.

stellar-gnome-96814d.netlify.app

Table of contents

• Table of contents
• Introduction
• Wireframe
• Codebase
  • Technologies
  • Folder structure
  • Code Style
• Setup Process
• Acknowledgments

Introduction

Wireframe

Wireframe Miro Board

Codebase

Technologies

Almost the entire codebase consists in Javascript

Here is a list of technologies used:

• React: Front-end library
• Redux: Global state management
• Jest & React Testing Library: Testing suite

Folder structure

reddit-client/
├── public     # Public files used on the frontend
└── src        # Frontend SPA

reddit-client/src
├── api            # Api call / information
├── components     # Reusabble parts
├── features       # Redux slices
├── helpers        # Utilify functions
├── hooks          # Custom hooks
├── pages          # Application views
├── store          # Redux store configuration
└── theme          # Material UI theme configuration

reddit-client/src/components
└── card           # Card call and setup of each post

reddit-client/src/features
├── Avatar         # Users avatar image
├── Comment        # Post comment info
├── Headar         # Page header
├── Home           # Home page error interactions
├── Post           # Individual post info
└── Subreddits     # Side navigation of subreddits listed

Code Style

Running Prettier on-commit, which means you can write code in whatever style you want and it will be automatically formatted according to the common style when you run git commit.

Setup Process

• Clone or download the repo
• Open the directory and run yarn to install
• Run development application by using yarn start

Acknowledgments

The project is using Reddit JSON Api to get the data from Reddit

The project was a task given by Codecademy being a part of their full-stack engineer course path. The goal of the project was to showcase all previews skills and technologies learned until this point on the path (HTML / CSS, JavaScript, React, Redux, Jest, Enzyme and Selenium, Git and Github Projects, Command line, Wireframes)