PopcornPal is a React-based web application for managing and rating movies. It provides a user-friendly interface to search for movies, view details, and keep track of watched movies.
- Installation
- Usage
- Project Structure
- Available Scripts
- Dependencies
- DevDependencies
- Contributing
- License
- Clone the repository:
git clone https://github.com/krtcrvy/popcorn-pal.git
- Navigate to the project directory:
cd popcorn-pal
- Install the dependencies:
pnpm install
To start the development server, run:
pnpm run dev
Open your browser and navigate to http://localhost:5173
to see the application in action.
popcorn-pal/
├── .gitignore
├── biome.json
├── eslint.config.js
├── index.html
├── package.json
├── pnpm-lock.yaml
├── public/
├── README.md
├── src/
│ ├── App.jsx
│ ├── assets/
│ ├── components/
│ │ ├── Box.jsx
│ │ ├── ErrorMessage.jsx
│ │ ├── Loader.jsx
│ │ ├── Logo.jsx
│ │ ├── Main.jsx
│ │ ├── Movie.jsx
│ │ ├── MovieDetails.jsx
│ │ ├── MovieList.jsx
│ │ ├── Navbar.jsx
│ │ ├── NumResults.jsx
│ │ ├── Search.jsx
│ │ ├── Star.jsx
│ │ ├── StarRating.jsx
│ │ ├── WatchedMovie.jsx
│ │ ├── WatchedMoviesList.jsx
│ │ ├── WatchedSummary.jsx
│ ├── hooks/
│ │ ├── useKey.js
│ │ ├── useLocalStorageState.js
│ │ ├── useMovies.js
│ ├── index.css
│ ├── main.jsx
├── vite.config.js
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:5173 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Builds the app for production to the dist
folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
Runs ESLint to analyze the code for potential errors and code style issues.
Serves the production build locally to preview it.
prop-types
: ^15.8.1react
: ^18.3.1react-dom
: ^18.3.1
@biomejs/biome
: 1.8.3@eslint/js
: ^9.9.0@types/react
: ^18.3.3@types/react-dom
: ^18.3.0@vitejs/plugin-react-swc
: ^3.5.0eslint
: ^9.9.0eslint-plugin-react
: ^7.35.0eslint-plugin-react-hooks
: ^5.1.0-rc.0eslint-plugin-react-refresh
: ^0.4.9globals
: ^15.9.0vite
: ^5.4.1
Contributions are welcome! Please open an issue or submit a pull request for any changes.
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch
). - Make your changes.
- Commit your changes (
git commit -m 'Add some feature'
). - Push to the branch (
git push origin feature-branch
). - Open a pull request.
This project is licensed under the MIT License - see the LICENSE file for details.