A Simple Movie Application using React JS, Typescript and Tailwind css, allows user to search and see the trailer of the movie.
Check out a live demo and try it for yourself: Live demo
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
**Prerequisites**
- git If you want to clone the project from GitHub and work with it locally, you will need to have Git installed on your system. You can download and install Git from the official website (https://git-scm.com/).
- Node.js Application requires Node.js to be installed on your system in order to run. You can download and install the latest version of Node.js from the official website (https://nodejs.org/).
- npm (Node Package Manager)
npm is the package manager for Node.js, and is used to manage the dependencies and packages required for your Next.js project. It is installed automatically when you install Node.js.
To check if npm is installed on your system, you can open a terminal or command prompt and enter the following command:
npm -v
Once you have these prerequisites in place, you can proceed to clone the project from GitHub using Git.
**Installing**
Make sure you have all the necessary prerequisites installed on your system. Follow the below steps to install the setup the project on your machine:
-
Open a terminal or command prompt and navigate to the directory where you want to clone the project.
-
Run the following command to clone the project from GitHub:
git clone https://github.com/sudeepmahato16/movies-app.git
-
This will create a new directory called "movies-app" in the current location, containing the code for the movie app project.
-
Navigate to the project directory by running the following command:
cd movies-app
-
Run the following command to install the project's dependencies using npm:
npm install --legacy-peer-deps
-
Start the server
npm run dev
-
To use the movie project, you will need to set up some environment variables on your development machine. Here are the steps to follow:
- Create a
.env
file in the root of the project. - Add the following variables to the
.env
file, replacing the placeholder values with your own:
VITE_API_KEY=<your-tmdb-api-key> VITE_TMDB_API_BASE_URL = https://api.themoviedb.org/3
- Save the
.env
file.
- Create a
-
Once the dependencies are installed, you can run the project locally by running the following command:
npm run dev
This will start the development server and open the movie application in your default web browser.
We welcome contributions to movie app! If you have an idea for a new feature, an improvement to an existing feature, or a bug fix, please open an issue to discuss it before submitting a pull request. This helps me to review and understand your changes more efficiently.
To contribute code to movie app project:
- Fork the repository
- Create a new branch for your feature or bug fix
- Commit your changes to the new branch
- Run the automated tests to ensure that your changes do not break any existing functionality
- Open a pull request back to the main repository, including a description of your changes and any relevant issue numbers
Thank you for your contribution to Movie app project! We appreciate your efforts to help make this a great movie application.