|
1 |
| -# React + Vite |
| 1 | +# SortLab |
2 | 2 |
|
3 |
| -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. |
| 3 | +**SortLab** is an interactive web application designed to help users understand and visualize how different sorting algorithms work in real time. Built using **React** and **Tailwind CSS**, SortLab offers an engaging way to explore sorting techniques through smooth, dynamic animations. |
4 | 4 |
|
5 |
| -Currently, two official plugins are available: |
| 5 | +## 🚀 Features |
6 | 6 |
|
7 |
| -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh |
8 |
| -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh |
| 7 | +- 🎯 **Sorting Algorithm Visualizer**: Real-time visual demonstrations of popular sorting algorithms like Bubble Sort, Merge Sort, Quick Sort, Insertion Sort, and more. |
| 8 | +- 💡 **User-Friendly Interface**: Clean and responsive UI built with Tailwind CSS for an intuitive and seamless experience. |
| 9 | +- 🛠️ **Interactive Controls**: Customize array size, animation speed, and choose different algorithms to visualize. |
| 10 | +- ⚙️ **Built with Modern Tools**: Developed using React and styled with Tailwind CSS for fast, efficient, and maintainable development. |
| 11 | +- 🌐 **Fully Free to Use**: No sign-ups or authentication required. Open and accessible for everyone. |
9 | 12 |
|
10 |
| -## Expanding the ESLint configuration |
| 13 | +## 📸 Demo |
11 | 14 |
|
12 |
| -If you are developing a production application, we recommend using TypeScript and enable type-aware lint rules. Check out the [TS template](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts) to integrate TypeScript and [`typescript-eslint`](https://typescript-eslint.io) in your project. |
| 15 | +[SortLab](https://sorting-visualizer-rahul-goswamis-projects-c6755eb5.vercel.app/) |
| 16 | + |
| 17 | + |
| 18 | +## Tech Stack |
| 19 | + |
| 20 | +- **Frontend**: React |
| 21 | +- **Styling**: Tailwind CSS |
| 22 | +- **Deployment**: Vercel |
| 23 | + |
| 24 | +## Installation |
| 25 | + |
| 26 | +To set up the project locally, follow these steps: |
| 27 | + |
| 28 | +1. Clone the repository: |
| 29 | + |
| 30 | + ```bash |
| 31 | + git clone https://github.com/your-username/quready.git |
| 32 | + ``` |
| 33 | + |
| 34 | +2. Navigate to the project directory: |
| 35 | + |
| 36 | + ```bash |
| 37 | + cd quready |
| 38 | + ``` |
| 39 | + |
| 40 | +3. Install dependencies: |
| 41 | + |
| 42 | + ```bash |
| 43 | + npm install |
| 44 | + ``` |
| 45 | + |
| 46 | +4. Start the development server: |
| 47 | + |
| 48 | + ```bash |
| 49 | + npm start |
| 50 | + ``` |
| 51 | + |
| 52 | +5. Open the application in your browser at `http://localhost:3000`. |
| 53 | + |
| 54 | +## Folder Structure |
| 55 | + |
| 56 | +``` |
| 57 | +quready/ |
| 58 | +├── public/ # Public assets |
| 59 | +├── src/ # Source files |
| 60 | +│ ├── components/ # Reusable React components |
| 61 | +│ ├── pages/ # Page-level components |
| 62 | +│ ├── styles/ # Tailwind CSS configurations |
| 63 | +│ |
| 64 | +├── .gitignore # Git ignore rules |
| 65 | +├── package.json # Project metadata and dependencies |
| 66 | +└── tailwind.config.js # Tailwind CSS configuration |
| 67 | +``` |
| 68 | + |
| 69 | +## Contributing |
| 70 | + |
| 71 | +Contributions are welcome! If you'd like to contribute, please fork the repository and create a pull request with your proposed changes. |
| 72 | + |
| 73 | +1. Fork the project |
| 74 | +2. Create a feature branch (`git checkout -b feature/YourFeature`) |
| 75 | +3. Commit your changes (`git commit -m 'Add YourFeature'`) |
| 76 | +4. Push to the branch (`git push origin feature/YourFeature`) |
| 77 | +5. Open a pull request |
| 78 | + |
| 79 | +## License |
| 80 | + |
| 81 | +This project is licensed under the MIT License. See the `LICENSE` file for details. |
| 82 | + |
| 83 | +## Feedback |
| 84 | + |
| 85 | +If you have any feedback, suggestions, or encounter any issues, please feel free to reach out or create an issue in the repository. |
| 86 | + |
| 87 | +--- |
| 88 | + |
| 89 | +<p align="center"> |
| 90 | + Happy coding and good luck with your interviews! 🚀<br/> |
| 91 | + Made with ❤️ by <strong>Rahul Goswami</strong> |
| 92 | +</p> |
0 commit comments