Filmpire - Jovan Vukić

Filmpire - AI Powered Movie App [React.js, Material UI, Alan AI]
Explore the project »

View Demo Site · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

Filmpire combines the desire to unleash powerful creativity with the industry's most advanced JavaScript tools including React.js, Redux, Material UI, Alan AI, and more.

Features include:

• user authentication,
• light and dark mode,
• API calls with axios and Redux,
• actors and movie details page,
• watchlist and list of favorite movies,
• movie search functionality,
• Alan AI voice functionality and many more.

Alan works as an in-app voice assistant for the Filmpire project.

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

List of things you need to use and how to install them:

• npm

  npm install npm@latest -g

Installation

Setup:

1. Get a free TMDB API Key at https://www.themoviedb.org/.

2. Clone the repo:

   git clone https://github.com/jovan-vukic/filmpire.git

3. Install NPM packages:

   npm install

4. Create your .env file as it is instructed in .env.example.

5. Enter your TMDB API key in your .env.

   REACT_APP_TMDB_KEY=<put your key here>

(back to top)

Usage

For a full demonstration of all the functionalities of this phenomenal web application check out this demo site.

For more detailes regarding TMDB API calls, please refer to the Documentation.

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)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Contact

Jovan - @jovan-vukic

Project Link: https://github.com/jovan-vukic/filmpire

(back to top)

Acknowledgments

Used resources:

• The Movie DB API Documentation
• Alan AI Documentation
• MUI Library
• JavaScript Mastery

(back to top)