Giter VIP home page Giter VIP logo

laravel-tv-library's Introduction

PlanHappy TV ๐Ÿ“บ

PlanHappy TV is a web app which allows users to track which TV show episodes they've watched and add shows to their watchlist.

Functionality overview

  • A User should be able to:
    • Mark Episodes as watched/unwatched
    • Add/Remove Shows to/from their Watchlist
    • Set their Watchlist to private to prevent access by other users
    • Be notified about upcoming airing Episodes

Page Structure

The following page structure will be required:

Home Page

Content to include

  • Most watched Episodes
  • Upcoming Episodes

Show

Content to include

  • Watchlists that include the Show
    • Only watchlists that are visible to the logged in user
  • Seasons belonging to the Show
  • The next airing Episode, if there is one

Actions that can be performed

  • Add/Remove Show to/from Watchlist

Season

Content to include

  • Episode list, ordered by air date

Episode

Content to Include

  • List of Users who have watched

Actions that can be performed

  • Mark as watched/unwatch
    • Only if the Episode has aired

User Profile

Content to include

  • The User's Watchlist with a list of Shows
  • Recently watched Episodes

Actions that can be performed

  • Toggle visibility of the Watchlist

Additional Tasks

Upcoming Show Notification

Send out a basic email notification to a User 1 hour before an Episode airs if the user has the Show on their Watchlist.

Testing

Please write some HTTP Tests to test various functionality.

Some initial tests have been added to tests/Feature/HttpTest. There are a handful of incomplete tests in here which will need implementing.

Feel free to write additional tests for any other functionality that may require it.

Don't worry about hitting 100% test coverage.

You can run the PHPUnit test suite with composer test

Development

Requirements

This project assumes you have developed a Laravel app locally before using a solution such as Homestead or Valet.

Instructions

  • Clone this repository to your local machine
  • Create a new branch to complete your work
  • Copy the .env.example file to .env
  • Run composer install
  • Run php artisan key:generate
  • Run npm install
  • Run npm run dev
  • Update the database values in the .env file
  • Run php artisan migrate:fresh --seed
  • Commit changes as you go and don't forget to push changes to the repository
  • Create Pull Request on GitHub to merge your branch back into master
  • You can use this Pull Request to ask for any help that may be required from us.
  • When finished assign the Pull Request to @seanmtaylor

Coding Standards/Guidelines

  • Please follow PSR-12
  • Add parameter type hints where possible
  • Add method return types where possible
  • Use Form Requests for validation
  • Use Policies for Authorization
  • Reuse blade views where possible
  • Ensure eager loading is used where possible to avoid any N + 1 issues

Tips

  • Don't worry too much about how things look from a design perspective
  • Some code has already been written for you, this may contain mistakes or things that can be optimised
  • Feel free to refactor anything

Tools

The following tools have been added to help you with your development

  • Telescope - accessible at yourappurl.test/telescope
  • PHP-CS-Fixer - composer style - This will follow PSR-2 as well as some additional rules
  • PHPStan - composer analyse - This will analyse your code for any potential errors
  • Laravel IDE Helper - composer ide-helper - Generates helper files that enable your IDE to provide accurate autocompletion

laravel-tv-library's People

Contributors

seanmtaylor avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.