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.

📝 Table of Contents

• About
• Getting Started
• Usage
• Tests
• Deployment
• Built Using
• Contributing
• Authors
• Acknowledgments

🧐 About

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.

🏁 Getting Started

To get started clone this repository or fork it. To clone follow this command

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

Install dependencies

yarn install

🎈 Usage

After cloning this repository and installing it's dpendencies, you can start the local development server by running the following command

yarn 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.

🔧 Running the tests

Jest

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

yarn test

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

To know more about testing go to MORE

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.

Prettier linting

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

yarn 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.

🚀 Deployment

This site is deployed at GitHub Pages - https://lmcjt37.github.io/curated-tv-and-film/

⛏️ Built Using

• HTML - Structural Language
• CSS - Styling Language
• JavaScript - Programming Language
• React - Frontend Framework
• Material UI - React UI Library
• Lodash - JavaScript Library
• Jest - Testing Library

✍️ Authors

• @lmcjt37

Visit here for contributors list - Contributors

Contribution

Feel free to contribute by reading the guidelines - Contributing

🎉 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