Skip to content

Latest commit

 

History

History
98 lines (66 loc) · 2.72 KB

README.md

File metadata and controls

98 lines (66 loc) · 2.72 KB

MovieTV App Frontend

Version: v2.1.0

Overview

This project is a Next.js frontend for a MovieTV app, utilizing TypeScript and MUI Devias as a baseline. The app provides functionality for users to view titles, add reviews, delete reviews, and more. Users can authenticate using Google login, manage their profiles, and verify their email addresses for sign-up and password resets. The frontend also supports dark mode and employs improved context management using useReducer. Environment variables have been introduced for easy configuration.

New Features (v2.1.0)

  • MUI v6 Update: Upgraded to the latest Material-UI (MUI) version 6.
  • Unit Tests Added: Basic unit tests have been introduced, including labels connected to controls for testing purposes.
  • Minor Bug Fixes: Various small bug fixes to improve app stability.

Installation and Setup

  1. Clone the repository:
git clone <repository-url>
  1. Navigate to the project directory:
cd <project-directory>
  1. Install dependencies:
npm install
  1. Set up environment variables by creating a .env file in the root directory and adding the following values:
NEXT_PUBLIC_GOOGLE_CLIENT_ID=<your-google-client-id>
NEXT_PUBLIC_SITE_URL=<your-site-url>
  1. Start the development server:
npm run dev

Usage

  • Navigate to the homepage to explore available titles.
  • Sign up or log in with Google to access additional features.
  • Manage your user profile and settings.
  • Add reviews to titles or delete your own reviews.
  • Admin users can add new titles and delete reviews from any user.

Features

  • Google Login: Use your Google account for authentication.
  • Email Verification: For sign-up and password reset functionality.
  • Profile Management: Users can update their profiles.
  • Dark Mode Support: Toggle between light and dark modes.
  • Context Management: Enhanced state management using useReducer.

Testing

  • Run unit tests:
npm run test

Dependencies

  • Next.js
  • TypeScript
  • Material-UI (MUI)
  • Axios
  • Google API Client
  • Django Backend Running

Docker Production Setup

  • Dockerfile is available for production deployment.

Contributing

Contributions are welcome! If you'd like to contribute to this project, please follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature-name).
  3. Make your changes.
  4. Commit your changes (git commit -am 'Add some feature').
  5. Push to the branch (git push origin feature/your-feature-name).
  6. Create a new Pull Request.

License

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