https://github.com/coderswarup/tuts-copy
https://github.com/coderswarup/tuts-copy
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/coderswarup/tuts-copy
- Owner: CoderSwarup
- Created: 2025-01-10T19:03:12.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-20T15:16:30.000Z (about 1 year ago)
- Last Synced: 2025-03-24T17:52:38.672Z (11 months ago)
- Language: TypeScript
- Homepage: https://tuts-master.vercel.app/
- Size: 10.4 MB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📚 Master Mathematics with Tuts
Master Mathematics with **Tuts** is an interactive learning platform that makes understanding mathematics intuitive and engaging. With the help of 3D visualizations using **Three.js** and **React Three Fiber**, step-by-step guidance, and practice problems, students can explore and master mathematical concepts in a fun and effective way.
---
## 🌟 Features
1. **Interactive Learning with 3D Visualizations**
Engage with **3D models** and real-time visualizations powered by **Three.js** and **React Three Fiber** to understand complex mathematical concepts effortlessly.
2. **Step-by-Step Guidance**
Follow clear and concise instructions with visual demonstrations and audio narration for an immersive learning experience.
3. **Practice Problems**
Solve interactive exercises with instant feedback to reinforce your understanding and build confidence.
---
## 🖥️ Technologies Used
- **React.js**: For building a dynamic and interactive user interface.
- **React Three Fiber**: For rendering and interacting with 3D models in React applications using **Three.js**.
- **Three.js**: For creating 3D visualizations and interactive graphics.
- **React Router**: For seamless navigation across multiple pages.
- **Lucide Icons**: To enhance the UI with modern and lightweight SVG icons.
- **Tailwind CSS**: For fast and responsive styling with utility-first CSS.
---
## 🚀 Getting Started
### Prerequisites
- Node.js (v14 or higher)
- npm or yarn
### Installation
1. Clone the repository:
```bash
git clone https://github.com/CoderSwarup/tuts.git
cd tuts
```
2. Install dependencies:
```bash
npm install
# or
yarn install
```
3. Start the development server:
```bash
npm start
# or
yarn start
```
4. Open your browser and visit:
`http://localhost:3000`
---
## 🛠️ Key Components
- **LandingPage**: The main entry point featuring a hero section, interactive features, and a "Get Started" button to navigate to the introduction page.
- **Sidebar**: A mobile-friendly menu that expands for quick navigation between sections.
- **ThreeDModel**: A component that uses **React Three Fiber** to render interactive 3D models, making complex mathematical concepts more accessible.
- **ThreeDVisualizer**: A component that utilizes **Three.js** to display 3D visualizations in the learning modules.
---
## 📚 How It Works
1. Start at the **Landing Page** to explore the platform's features.
2. Click "Get Started Learning" to navigate to the **Introduction Page**.
3. Explore exercises like the **Pythagoras Exercise**, engage in activities, or solve practical problems like the **Ladder Problem**.
4. Visualize complex concepts in **3D** using **Three.js** and **React Three Fiber**, providing an immersive learning experience.
---
## 🛡️ License
This project is licensed under the **MIT License**.
Feel free to use, modify, and distribute this project.
---
## 👨💻 Contributing
Contributions are welcome! If you'd like to improve the project or fix bugs, please:
1. Fork the repository.
2. Create a new branch:
```bash
git checkout -b feature/your-feature
```
3. Make your changes and commit them:
```bash
git commit -m 'Add a new feature'
```
4. Push to the branch:
```bash
git push origin feature/your-feature
```
5. Submit a pull request.
---
## ✨ Acknowledgments
- Thanks to **Lucide Icons** for providing elegant SVG icons.
- Special thanks to **Three.js** and **React Three Fiber** for enabling interactive 3D visualizations.
- Inspired by the need to make mathematics accessible and fun for everyone.