Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
azaynul10 authored Sep 30, 2024
1 parent 29e6152 commit 3f54c07
Showing 1 changed file with 52 additions and 41 deletions.
93 changes: 52 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,81 @@
# Getting Started with Create React App
# Infinity Stone Gauntlet Hand Pose Recognition

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
#### A Marvel-ous Project by Zaynul Abedin Miah

## Available Scripts
![Infinity Gauntlet](https://example.com/infinity_gauntlet.gif)

In the project directory, you can run:
## 🌟 Project Overview

### `npm start`
After an exhausting day of 3 final exams in 1 day, I decided to embark on an exciting project instead of resting. Inspired by the Infinity Gauntlet from Avengers: Endgame, I created a hand pose recognition model using TensorFlow.js and React.js. This project combines the power of deep learning with the magic of the Marvel Cinematic Universe!

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
**Key Features:**
- Real-time hand pose detection using your webcam
- 3D mesh creation of your hand
- Infinity Stone effects based on hand gestures

The page will reload when you make changes.\
You may also see any lint errors in the console.
## 🚀 Quick Start

### `npm test`
1. Clone the repository:
```
git clone https://github.com/zaynul-abedin-miah/infinity-stone-gauntlet.git
cd infinity-stone-gauntlet
```

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
2. Install dependencies:
```
npm install
```

### `npm run build`
3. Start the development server:
```
npm start
```

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
4. Open `http://localhost:3000` in your browser and start wielding the power of the Infinity Stones!

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
**Note:** Make sure to install React.js files before contributing to this repository. Node modules and Vercel files are locked for security reasons.

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
## 🛠️ Technologies Used

### `npm run eject`
- TensorFlow.js
- React.js
- HTML5 Canvas
- React Webcam

**Note: this is a one-way operation. Once you `eject`, you can't go back!**
## 🎥 Demo

If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
![Demo GIF](https://example.com/infinity_gauntlet_demo.gif)

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
## 🤝 Contributing

You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
Contributions are welcome! Before you start, please make sure to:

## Learn More
1. Fork the repository
2. Create a new branch for your feature
3. Make your changes
4. Submit a pull request

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
**Important:** Ensure you have React.js installed before contributing.

To learn React, check out the [React documentation](https://reactjs.org/).
## 🚀 Deployment

### Code Splitting
This project is deployed on Vercel. You can view the live demo [here](https://infinity-gauntlet-hand-pose.vercel.app).

This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
## 💡 Inspiration

### Analyzing the Bundle Size
This project was inspired by:
- The Infinity Gauntlet from Avengers: Endgame
- Nicholas Renotte's tutorial on hand pose estimation
- GitHub Copilot's new advancements

This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
## ⚡ Fun Fact

### Making a Progressive Web App
I completed this project in just 50 minutes after coming home from my final exams and hitting the gym. Who says you can't save the universe and ace your finals at the same time?

This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
## 📜 License

### Advanced Configuration
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
---

### Deployment

This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)

### `npm run build` fails to minify

This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
**Remember:** With great power comes great responsibility. Use this Infinity Gauntlet wisely! 😉

0 comments on commit 3f54c07

Please sign in to comment.