/tmdb-movie-explorer

TMDB Movie Explorer

Primary LanguageJavaScript


TMDB MOVIE EXPLORER

โ—ฆ Developed with the software and tools below.

JavaScript HTML5 React JSON

GitHub license git-last-commit GitHub commit activity GitHub top language

๐Ÿ“– Table of Contents


๐Ÿ“ Overview

TMDB Movie Explorer is a straightforward and user-friendly website developed using React. This project was undertaken as a means to learn and master the basics of React. The core functionality of the website revolves around fetching movie data from the TMDB API. Visitors to the site are presented with a single-page interface where they can browse various movies. Each movie listing provides a general overview, including essential details and ratings. This format makes it easy for users to quickly find and assess movies of interest.


๐Ÿ“‚ Repository Structure

โ””โ”€โ”€ tmdb-movie-explorer/
    โ”œโ”€โ”€ package-lock.json
    โ”œโ”€โ”€ package.json
    โ”œโ”€โ”€ public/
    โ”‚   โ”œโ”€โ”€ index.html
    โ”‚   โ”œโ”€โ”€ manifest.json
    โ”‚   โ””โ”€โ”€ robots.txt
    โ””โ”€โ”€ src/
        โ”œโ”€โ”€ api/
        โ”‚   โ”œโ”€โ”€ API_UTILS.js
        โ”‚   โ””โ”€โ”€ TMDB_API.js
        โ”œโ”€โ”€ components/
        โ”‚   โ”œโ”€โ”€ actor_card/
        โ”‚   โ”œโ”€โ”€ app/
        โ”‚   โ”œโ”€โ”€ header/
        โ”‚   โ”œโ”€โ”€ iconButton/
        โ”‚   โ”œโ”€โ”€ movie/
        โ”‚   โ”œโ”€โ”€ movie_list/
        โ”‚   โ”œโ”€โ”€ movieRating/
        โ”‚   โ”œโ”€โ”€ navigation/
        โ”‚   โ””โ”€โ”€ popup/
        โ”œโ”€โ”€ index.css
        โ”œโ”€โ”€ index.js
        โ”œโ”€โ”€ reportWebVitals.js
        โ””โ”€โ”€ setupTests.js

๐Ÿš€ Getting Started

๐Ÿ”ง Installation

  1. Clone the tmdb-movie-explorer repository:
git clone https://github.com/SzybkiRito/tmdb-movie-explorer
  1. Change to the project directory:
cd tmdb-movie-explorer
  1. Install the dependencies:
npm install

๐Ÿค– Running tmdb-movie-explorer

npm start

๐Ÿงช Tests

npm test

๐Ÿค Contributing

Contributions are welcome! Here are several ways you can contribute:

Contributing Guidelines

Click to expand
  1. Fork the Repository: Start by forking the project repository to your GitHub account.
  2. Clone Locally: Clone the forked repository to your local machine using a Git client.
    git clone <your-forked-repo-url>
  3. Create a New Branch: Always work on a new branch, giving it a descriptive name.
    git checkout -b new-feature-x
  4. Make Your Changes: Develop and test your changes locally.
  5. Commit Your Changes: Commit with a clear and concise message describing your updates.
    git commit -m 'Implemented new feature x.'
  6. Push to GitHub: Push the changes to your forked repository.
    git push origin new-feature-x
  7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.

Once your PR is reviewed and approved, it will be merged into the main branch.


๐Ÿ“„ License

MIT LICENSE

Copyright (c) 2012-2023 Scott Chacon and others

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.