Skip to content

App for view informations about TV Shows such as summary, episodes and seasons

Notifications You must be signed in to change notification settings

jefersoneiji/j-flix

Repository files navigation

JFlix

TV Shows navigator

policy-diagram

Summary

This web app is able to navigate throw TV Shows, display its seasons and information about shows/seasons/episodes.

Prerequisites

For this project to run, make sure these software are installed:

Installing

To run locally:

  1. Clone this repo

    git@github.com:jefersoneiji/j-flix.git
  2. Install dependencies in your machine

    yarn install
  3. Start the front

    yarn dev

Testing

Execute the following command:

yarn test

Linting

yarn lint

Deploying

Deploy to netlify is done through github actions. The app is only deployed after all tests are green. See: deploy-workflow

Colocation

By following the principle of colocation, requests, styles and tests are placed as closer as possible to each other. Meaning, that requests may be found in the same file (or folder) containing tests and styles.

Example: In home.tsx the data loader is inside the home component itself.

Components

<Navbar />

Displays navigation bar

<Home />

Displays all TV Shows

<ShowDetails/>

Displays specific show info and episodes by season

API Fetching

Fetching

Requests are done through the Fetch API. See fetchAPI

Error Handling

Errors are handled in two levels:

  1. inside the fetchAPI or
  2. inside the component itself through an error handler. See: home showsLoader()

Future Improvements

  • Add storybook to project
  • Add more animation to components
  • Increase edge cases coverage in tests

Made by Jeferson Eiji ➡️ Get in touch!

About

App for view informations about TV Shows such as summary, episodes and seasons

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published