Skip to content

Latest commit

 

History

History
232 lines (179 loc) · 7.87 KB

README.md

File metadata and controls

232 lines (179 loc) · 7.87 KB

Contributors Forks Stargazers Issues LinkedIn


Logo

Cinemax

AI-powered movie web application with react, redux-toolkit, MUI, node
Explore the docs »

View Demo · Report Bug · Request Feature . Live Website

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Features
  5. Contributing
  6. Contact
  7. Acknowledgments

About The Project

Cinemax Screen Shot

Cinemax Movie Information page

(back to top)

Built With

  • React
  • MUI
  • NODE
  • REDUX
  • SWIPER
  • REACT ROUTER

(back to top)

Getting Started

  1. Get a free API Key and Read Access Token at TMDB (PS: Create an account if you don't have)

    • This app is divided into two main directories, the root is for all things node related while the client directory is for our react app
  2. Git clone this repo using:

    git clone https://github.com/chidubesteve/Cinemax.git

    Installation

  3. Navigate into the project directory:

    cd cinemax
  4. Install the project's dependencies:

    npm install or npm i

    or using YARN:

    yarn add
  5. Start the development server

    npm run dev
  6. cd into the client directory

    cd client && npm install
  7. Create an .env file and enter your API in config.js

    API_KEY = 'ENTER YOUR API';
    API_RAT = 'YOUR API READ ACCESS TOKEN';
  8. Start the dev server for the client

    npm start

if you get any error when downloading like (Could not resolve a particular dependency) then add the --legacy-peer-deps or -force argument to the install command.

(back to top)

Usage

If you want to know how to use or navigate the application, then check out this demo video, and if you want a tutorial on how to build this application, then reach out to me.

To know more about the app, please refer to the Demo Video

(back to top)

FEATURES

  • [ SEARCH FUNCTIONALITY ]
  • [ ROUTING ]
  • [ SECURITY ]
    • [ PROXY API CALLS ]
  • [LOGIN AND LOGOUT]
  • [LIGHT & DARK MODE]
  • [FULLY RESPONSIVE]
  • [PAGINATION]
  • [ AI VOICE COMMUNICATION - ALAN ]
  • [ SWIPER ANIMATIONS]

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Contact

Twitter - @PhoenixWeb3Dev

Gmail - anikechidube@gmail.com

Instagram - @phoenixdevhub

Project Link: CINEMAX

(back to top)

Acknowledgments

(back to top)