Skip to content

Latest commit

 

History

History
197 lines (153 loc) · 11.5 KB

README.md

File metadata and controls

197 lines (153 loc) · 11.5 KB
Raw

Maaagic UI Logo

Maaagic UI

Last Updated License Release Contributors Issues Pull Requests Stars Languages Count Code Size Commit Activity CodeQL Release

Visits Badge

Rust Tauri TypeScript Next JS
Github-sponsors

Maaagic UI is an all-in-one solution for building modern and feature-rich applications. It harnesses Next.js for seamless server-side rendering and Tauri for integrating GUI for Large Language Models and stable diffusions that operate natively on Windows, Linux, and MacOS. This UI empowers developers to craft intuitive and efficient user interfaces. Leveraging various large language models, Maaagic UI ensures exceptional performance and flexibility for diverse application needs. Get started with Maaagic UI today and unlock endless possibilities for your AI Models.

Table of Contents

Getting Started

Clone the repository:

gh repo clone https://github.com/muhammad-fiaz/MaaagicUI.git
cd MaaagicUI

then, get start development server by:

npm i
npm run tauri:dev
npm run tauri:build

Features

  • Builtin CivitAI download Store
  • Supports Windows, macOS, and Linux
  • Support for dark and light modes
  • Components-based UI design
  • A draggable title bar with minimize, maximize, and close buttons
  • A sidebar with a navigation menu
  • UI for AI Development
  • AI Based Application
  • Large Language Models
  • Stable Diffusion
  • Responsive design
  • Customizable theme

Stacks Used

Customization

The template can be customized by editing the following files:

  • To customize a application settings you can do it from src-tauri/tauri.conf.json
  • This contains a npm dependencies package.json
  • This contains a cargo dependencies src-tauri/cargo.toml
  • To change the app icon, update app-icon.png, and then run npm tauri icon. This will automatically generate icon files into src-tauri/icons. You can also manually replace the icon files in src-tauri/icons.
  • To add more components you can use shadcn/ui for UI components

Folder Structure

.
├── backend                 # Main directory for your Python backend
│   ├── app.py              # Main application file
│   ├── requirements.txt    # Python dependencies
│   └── ...                 # Other Python files and directories
├── prisma                  # Prisma directory
│   └── schema.prisma       # Prisma schema file
├── src                     # Main directory for your frontend source code
│   ├── app                 # Contains your Next.js application
│   ├── assets              # Contains static assets for your project
│   ├── components          # Contains UI components for your project
│   ├── data                # Contains data for your project
│   ├── hooks               # Contains React hooks for your project
│   ├── lib                 # Contains utility functions and libraries used in your project
│   └── styles              # Contains style-related files for your project
├── src-tauri               # Main directory for your backend source code
│   └── icons               # Contains the icons for your application
├── public                  # Contains public assets that will be served by Next.js
├── README.md               # Contains information about your project and how to use it
├── package.json            # Contains the list of npm dependencies for your project
├── tsconfig.json           # Used to specify the root files and the compiler options required to compile the project
├── next.config.js          # Used for configuring Next.js
├── postcss.config.js       # Used for configuring PostCSS
├── prettier.config.js      # Used for configuring Prettier
└── tailwind.config.js      # Used for configuring Tailwind CSS

Recommended IDE Setup

these are the recommended IDEs for this project:

License

This project is licensed under the GNU General Public License v3.0. See LICENSE for the full license text.

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request if you have a way to improve this project.

Code of Conduct

This project and everyone participating in it is governed by the Maaagic UI Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior by either discussion or issues.

Support and Thanks

Thank you for using Maaagic UI! Your support means a lot to us. If you encounter any issues or have suggestions for improvement, please don't hesitate to open an issue on GitHub. Your feedback helps us make Maaagic UI even better.

If you'd like to show your appreciation or support further development, here are some ways you can contribute:

  • Star the Project: Show your support by giving the project a star ⭐ on GitHub.
  • Contribute: If you're interested in contributing to the project, feel free to fork it and submit your changes as a pull request. We welcome contributions of all kinds, from bug fixes to new features.
  • Fork the Project: If you'd like to contribute to the project, you can fork it and submit your changes as a pull request. We welcome contributions of all kinds, from bug fixes to new features.
  • Sponsor on GitHub: Consider becoming a sponsor on GitHub to provide ongoing financial support. Your sponsorship helps us cover maintenance costs and supports future development efforts.

Sponsor muhammad-fiaz

Your contributions, feedback, and support are immensely valuable to us. Thank you for being a part of the Maaagic UI community!