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.
MINIDOCS
MINIDOCS is a modern and responsive documentation site built using React with Vite configuration, Tailwind CSS, and Framer Motion. The standout feature of this project is the drag functionality provided by Framer Motion, which offers an incredibly smooth and intuitive user experience.
Features
š Responsive design for various screen sizesš Modern and clean user interface
š Smooth drag functionality using Framer Motion
š Efficient performance with Vite
š Tailwind CSS for quick and easy styling
Prerequisites
Ensure you have the following installed before starting:
š Node.js(v14.x or later)š npm (v6.x or later) or yarn
Installation
Follow these steps to set up the project locally:
- Clone the repository:š git clone https://github.com/Rupak-25/MINIDOCS.git
š cd MINIDOCS
š cd minidocs
Install the dependencies:
š npm install or yarn installRunning the Project
To start the development server, use:
š npm run dev or yarn devThis will run the app in development mode. Open your localhost to view it in the browser.
Building for Production
To create a production build, run:
š npm run build or yarn buildThis will build the project for production, optimizing the output for best performance.
Project Structure
- public/: Static files and the main HTML template- src/: Source files including React components and Tailwind CSS styles
- components/: Reusable UI components
- pages/: Main pages of the application
- App.jsx: Main application file
- main.jsx: Entry point of the application
- index.css: Global styles including Tailwind CSS imports
Contributing
Contributions are welcome! Please fork the repository and submit a pull request with your changes. Ensure your code follows the project's coding standards.License
This project is licensed under the MIT License. See the LICENSE file for more details.Thank You
āØ A big shoutout and thank you for exploring this innovative project! Your invaluable feedback and unwavering support are the sparks that keep our creative fire burning. š Let's keep coding and creating magic together! šš