Skip to content

Latest commit

 

History

History
215 lines (135 loc) · 6.76 KB

README.md

File metadata and controls

215 lines (135 loc) · 6.76 KB

Logo

CATALOGUE OF MOVIES

Web App created by Steven Jack Chung
Project created using TheMovieDB API and ReactJS & Redux

‎ ‎ ‎ ‎

Table of Contents

🎬 About Movie Finder

Movie Finder is a movies catalogue where you can find all the popular, top rated, and upcoming movies. You can browse and filter all the movie available as well as finding all basic information of each move in the listing. It was build with ReactJS & Redux and The MovieDB was the API used to retrieve all information for the movies catalogue.

⚒️ Built With React & Redux

React ReactJS

Redux Redux

Netlify

Axios

🟢 Live Demo

image

🖥️ Setup

Requirements

Internet Browser (Chrome, Firefox, Opera, etc)

Git for version control.

Node.js is required to install dependencies and run scripts via npm.

Installation

After installing the tools required, go ahead and clone this repository by using Git commands.

    git clone https://github.com/jcy2704/movie-finder.git

Or you can also download this repository and access it with navigation commands.

    cd /path/to/repository/movie-finder

To be able to run the web app smoothly you need to install Node dependencies by typing the following command on your terminal

    npm install

Now you are good to go!

Run Movie Finder App

Now that you've installed the repository correctly. Go ahead and test it out by running the following command on the terminal

    npm start

This command will open a localhost:3000 server where it will be running the web app until you close the server by using the key combo CTRL + C on the terminal.

And there you are running the app.

Enjoy!

✍️ Making Your Own Changes

Available Commands

Command Description
npm install Install project dependencies
npm start Build project and open web server running project
npm run build Builds code bundle with production settings (minification, uglification, etc..)
npm test Test the the created test cases

Writing Code

After cloning the repo, run npm install from your project directory. Then, you can start the local development server by running npm start.

After starting the development server with npm start, you can edit any files in the src folder and webpack will automatically recompile and reload your server (available at http://localhost:3000 by default).

Creating your own ENV variables

To be able to create your own environmental variables you need to create a .env file in the root of the project.

You need to also name the variable with the follow prefix REACT_APP_.

For example,

  // .env

  REACT_APP_API_KEY=1234567
  REACT_APP_API_URL=https://api.example.com/

Testing Code

To test your code, or changes, you need to create test cases for those. You can visit on the internet to learn how to create your test cases. After you create the cases, you can just run the test command on the terminal npm test and check if all test pass. If not then you need to fix your test cases or fix your code.

Deploying Code

This project is deployed to Heroku, but you can use Netlify or other platforms you like.

For Heroku deployment we you can enter each of the following commands.

    heroku create your-app-name --buildpack mars/create-react-app

    // you can remove 'your-app-name' if you don't know what name to put


    git push heroku master

    // if you are deploying the project from the master branch


    git push heroku your-branch:master

    // if you are deploying from a branch different from master


    heroku open

After you deploy to Heroku, you need to go to the dashboard and create the environmental variables just like you did before in the .env, for Heroku.

You can visit the following link to learn how to add it.

And there you go! You have your app deployed to Heroku.

👤 Author

👤 Steven Jack Chung

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐ Show your support

Give a ⭐️ if you like this project!