Skip to content

Latest commit

 

History

History
61 lines (46 loc) · 1.65 KB

README.md

File metadata and controls

61 lines (46 loc) · 1.65 KB

📄 Docs Mini App

An animated documentation app built using React.js and Framer Motion. This project provides a smooth and interactive way to display documentation with engaging animations.

🌐 Live Demo

Check out the live version here: Docs Mini App

🚀 Features

  • 📜 Beautiful UI for displaying documentation.
  • 🎨 Framer Motion Animations for a smooth user experience.
  • ⚡ Fast and Responsive design.
  • 🔧 Easy to Customize and Extend.

🛠 Installation & Setup

Prerequisites

  • Node.js (>= 14.x)
  • npm or yarn

Clone the Repository

git clone https://github.com/ExploitEngineer/Docs_Mini_App.git
cd Docs_Mini_App

Install Dependencies

npm install  # or yarn install

Run the App

npm start  # or yarn start

The app will be available at http://localhost:3000/.

📌 Usage

  • Browse through the documentation sections.
  • Experience smooth animations with Framer Motion.
  • Modify the components inside the src/components/ directory to customize the content.

🛠 Technologies Used

  • React.js – For building the UI.
  • Framer Motion – For animations.
  • Tailwind CSS – For styling.

🤝 Contributing

Want to improve the project? Follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-name).
  3. Commit your changes (git commit -m 'Add a new feature').
  4. Push to your fork (git push origin feature-name).
  5. Create a pull request.

📜 License

This project is licensed under the MIT License.

🚀 Feel free to contribute and enhance this project!