https://github.com/rupak-25/minidocs
MINIDOCS is an ultra-responsive, modern documentation site built with React, Vite, and Tailwind CSS. Featuring Framer Motion's phenomenal drag feature, it redefines user interaction with a sleek, dynamic interface. Below given commands in readme page is the way you can checkout the final outcome of the project.
https://github.com/rupak-25/minidocs
animation basics docs drag-and-drop framer-motion framework frontend full-stack-web-development html-css-javascript javascriptlibrary minidocs reactjs responsive-design skills
Last synced: 7 days ago
JSON representation
MINIDOCS is an ultra-responsive, modern documentation site built with React, Vite, and Tailwind CSS. Featuring Framer Motion's phenomenal drag feature, it redefines user interaction with a sleek, dynamic interface. Below given commands in readme page is the way you can checkout the final outcome of the project.
- Host: GitHub
- URL: https://github.com/rupak-25/minidocs
- Owner: Rupak-25
- Created: 2024-12-06T09:29:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-10T14:43:12.000Z (over 1 year ago)
- Last Synced: 2025-03-28T06:41:44.634Z (about 1 year ago)
- Topics: animation, basics, docs, drag-and-drop, framer-motion, framework, frontend, full-stack-web-development, html-css-javascript, javascriptlibrary, minidocs, reactjs, responsive-design, skills
- Language: JavaScript
- Homepage:
- Size: 55.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
#
📝 MINIDOCS ✨
---
## 🚀 Features
- 🎨 **Responsive design for various screen sizes**
- ⚡ **Smooth drag functionality using Framer Motion**
- 🌐 **Efficient performance with Vite**
- 🤝 **Tailwind CSS for utility-first styling**
- ✅ **Responsive layout adaptable to all devices**
---
## 🛠️ Tech Stack
---
## ⚙️ Prerequisites
Ensure you have the following installed:
- [Node.js](https://nodejs.org/) (v14.x or later)
- [npm](https://www.npmjs.com/) (v6.x or later) or [Yarn](https://yarnpkg.com/)
---
## 🛠️ Installation
Clone the repository and set up locally:
```bash
git clone https://github.com/Rupak-25/MINIDOCS.git
cd MINIDOCS
cd minidocs
```
Install dependencies:
```bash
npm install
# or
yarn install
```
---
## 💻 Running the Project
Start the development server:
```bash
npm run dev
```
Click the localhost link in your terminal to play in the browser!
---
## 🏗️ Building for Production
Create an optimized production build:
```bash
npm run build
# or
yarn build
```
This command builds the project for production, ensuring the highest performance.
---
## 🤝 Contributing
We welcome your contributions!
- **Fork** the repository
- **Create a new branch** for your feature or fix
- **Submit a pull request**
Please ensure your code follows project guidelines and style.
---
## 📄 License
This project is licensed under the [MIT License](LICENSE).
---
> _"Documentation made effortless—MINIDOCS delivers clarity, speed, and a distraction-free reading experience."_