Giter VIP home page Giter VIP logo

curated-tv-and-film's Introduction

CircleCI contributions welcome

Curated-TV-and-Film

The purpose of the project is to show a curated list of Modern TV shows or Films, where iconic scenes that include speeches, action scenes, classic quotes, etc. These can all be viewed easily and quickly to help in reference. Especially useful in arguments.

These scenes are carefully picked out moments, ignoring bias of any opinions or beliefs. So please be aware that because of this, certain links may cause offense.

Features

  • React and Javascript(built with Create-React-App).
  • Development server with Hot module reload.
  • Jest testing with snapshot testing.

Local Installation

Dependencies

git clone https://github.com/lmcjt37/curated-tv-and-film.git
npm install

Development

Start the local development server by running

npm start

The webpage will open automatically, otherwise navigate to http://localhost:3000/ in your browser.

Hot Module reload causes the server to automatically detect file changes and reload the project.

Project structure

The boilerplate structure is the same as what is created in Create-React-App.

./
|
├── public/
│   ├── assets/ - Other assets, thumbnail images.
│   ├── index.html - Defines root html for app.
│   └── manifest.json - Tells the browser about your web application and how it should behave when 'installed'.
|
└── src/
    ├── _tests_/ - Contains test environment (Jest + Enzyme).
    ├── assets/ - Other assets, icons.
    ├── fonts/ - Font files.
    ├── App.js - Core app functionality.
    ├── App.css - Styling.
    ├── content.js - Contains the data for tv shows and films for the project.
    ├── index.js - Project entry point.
    ├── index.css - Styling.
    ├── package.json - Defines dependencies and package scripts for project, plus project information.
    └── serviceWorker.js - (not registered) Defines registration for PWA usage.

Prettier linting

The JavaScript files can be prettyfied using Prettier with the following command:

npm run lint (yarn run lint)

Configuration for Prettier is found in .prettierrc.

The project also has pre-commit hooks for when code is commited to your local branches that will trigger this linting across the project.

Testing

Jest

Tests are found in ./src/__tests__ and to run tests across the project use the following command:

npm test (yarn test)

This will start the tests with watch mode active, meaning it will automatically detect file changes and re-test. Initially it will only test files which have changed, to test all files you will be prompted to press 'a'.

You can navigate the command prompt by pressing 'w', which will present you with the available commands.

Snapshots

Along with the Jest tests are snapshots. These are essentially for UI testing how your components are rendered. Any unexpected changes to your components will cause the snapshot tests to fail.

Provided that the components have been rendered correctly, you can fix and update the snapshot tests by pressing 'u' whilst the watch mode is being run. This will then update and re-run the tests to show you the passing state of your tests.

Tests are also run on a pre-commit hook to make sure tests are updated along with commits and don't break the build.

Contribution

Feel free to contribute by reading the guidelines - Contributing

Contributors

Visit here for contributors list - Contributors

Acknowledgements

This site is built with a number of tools, the main one being Create React App.

It is themed with Material UI, React components that implement Google's Material Design.

Images are sourced via search engines and are not owned by this site.

This site is not endorsed by or affiliated with IMDB.

Further help in running the project here

curated-tv-and-film's People

Contributors

berksaribas avatar comets1 avatar danielandro avatar davidlamt avatar diddy225 avatar eliotw avatar erangaheshan avatar giulianovarriale avatar harleo avatar isaniomoraes avatar izanf avatar jamil-tlbwork avatar jeff-duke avatar juni4567 avatar kamaldlk avatar kelvin-mai avatar kndarp avatar leeconnelly12 avatar lmcjt37 avatar maniacalbilby avatar mehdithefork avatar nemanjaglumac avatar oliver-gomes avatar pranay414 avatar ratatatcat avatar rodrigocnascimento avatar surmistry avatar thulakshimadu avatar tunedmidja avatar yamilurbina 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.