Skip to content

Latest commit

 

History

History
96 lines (68 loc) · 2.8 KB

readme.md

File metadata and controls

96 lines (68 loc) · 2.8 KB
Raw

react.movies

A React Movies application using The Movie Database (TMDb) API.

Quick Setup

  1. Clone the repository:

    git clone https://github.com/pirateIV/react.movies.git
cd react-movies

  2. Create and configure the environment file:

    • Rename your .env.sample file to .env.

  3. Obtain API keys:

  4. Enter the API keys into the .env file:

    VITE_TMDB_API_KEY=your_tmdb_api_key
VITE_YOUTUBE_API_KEY=your_youtube_api_key

Running the Application

  1. Install dependencies:

    npm install

  2. Start the development server at localhost:5173:

    npm run dev

Project Structure

react-movies/
├── .husky/                 # Husky config. for Git hooks.
├── public/                 # Static files.
├── src/                    # Source files.
│   ├── assets/             # Assets like images, icons, etc.
│   ├── components/         # React components.
│   ├── config/             # Configuration files.
│   ├── constants/          # Constants and enums.
│   ├── pages/              # Application pages.
│   ├── locales/            # Translations.
│   ├── routes/             # Routes configuration.
│   ├── services/           # Service utilities and API calls.
├── .env.sample             # Sample environment variables.
├── .gitignore              # Git ignore file.
├── package.json            # NPM package configuration.
├── README.md               # Project documentation.

Available Scripts

  • npm run dev: Starts the development server.

API Integration Overview

TMDb API

  • Base URL: https://api.themoviedb.org/3
  • Authentication: API Key (stored in .env file)

YouTube API (Optional)

  • Base URL: https://www.googleapis.com/youtube/v3
  • Authentication: API Key (stored in .env file)

Contributing

  1. Fork the repository.
  2. Create your feature branch (git checkout -b feature/YourFeature).
  3. Commit your changes (git commit -m 'Add some feature').
  4. Push to the branch (git push origin feature/YourFeature).
  5. Open a pull request.

Credits

This project idea is gotten from the foundational work by jason.codes

License

This project is licensed under the MIT License - see the LICENSE file for details.