Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/muhammad-fiaz/maaagicui
Maaagic UI is an open-source UI framework designed to empower developers with seamless integration and advanced features of AI applications.
https://github.com/muhammad-fiaz/maaagicui
civitai civitai-api diffusion-models gui large-language-models latent-diffusion maaagic maaagic-ai maaagic-ui magic-ui nextjs open-source stability-ai stable-diffusion stable-diffusion-tutorial stable-diffusion-webui tauri tauri-app text-to-image text-to-video
Last synced: 18 days ago
JSON representation
Maaagic UI is an open-source UI framework designed to empower developers with seamless integration and advanced features of AI applications.
- Host: GitHub
- URL: https://github.com/muhammad-fiaz/maaagicui
- Owner: muhammad-fiaz
- License: gpl-3.0
- Created: 2024-01-31T12:46:29.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-06-18T22:40:42.000Z (5 months ago)
- Last Synced: 2024-10-05T15:42:42.857Z (about 1 month ago)
- Topics: civitai, civitai-api, diffusion-models, gui, large-language-models, latent-diffusion, maaagic, maaagic-ai, maaagic-ui, magic-ui, nextjs, open-source, stability-ai, stable-diffusion, stable-diffusion-tutorial, stable-diffusion-webui, tauri, tauri-app, text-to-image, text-to-video
- Language: TypeScript
- Homepage:
- Size: 13.7 MB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
Maaagic UI
**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
- [Maaagic UI](#maaagic-ui)
- [Getting Started](#getting-started)
- [Features](#features)
- [Stacks Used](#stacks-used)
- [Customization](#customization)
- [Folder Structure](#folder-structure)
- [Recommended IDE Setup](#recommended-ide-setup)
- [License](#license)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
- [Support and Thanks](#support-and-thanks)
- [Star the Project](#star-the-project)
- [Contribute](#contribute)
- [Fork the Project](#fork-the-project)
- [Sponsor on GitHub](#sponsor-on-github)
## Getting Started
Clone the repository:
```bash
gh repo clone https://github.com/muhammad-fiaz/MaaagicUI.git
cd MaaagicUI
```
then, get start development server by:
```bash
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
- [Node.js](https://nodejs.org/en/) (v14 or later)
- [npm](https://www.npmjs.com/) (v7 or later) or [pnpm](https://pnpm.io/) (v6 or later)
- [Rust](https://www.rust-lang.org/) (v1.54 or later)
- [Tauri CLI](https://tauri.studio/en/docs/getting-started/intro) (v1.0.0-beta.5 or later)
- [Git](https://git-scm.com/)
- [Next.js](https://nextjs.org/) (v11 or later)
- [Tailwind CSS](https://tailwindcss.com/) (v2.2 or later)
- [TypeScript](https://www.typescriptlang.org/) (v4.4 or later)
- [prettier](https://prettier.io/) (v2.4 or later)
- [ESLint](https://eslint.org/) (v8.0 or later)
- [Cargo](https://doc.rust-lang.org/cargo/) (v1.54 or later)
- [Chakra UI](https://chakra-ui.com/) (v1.6 or later)
- [Chakra Icons](https://chakra-ui.com/docs/media-and-icons/icon) (v1.0 or later)
- [Radix UI](https://www.radix-ui.com/) (v0.3 or later)
- [Lucide Icons](https://lucide.dev/) (v1.0 or later)
- [React Icons](https://react-icons.github.io/react-icons/) (v4.2 or later)
- [shadcn/ui](https://github.com/shadcn/ui) for UI components
- [prisma](https://www.prisma.io/) (v3.0 or later)
- [Python](https://www.python.org/) (v3.9 or later)
- [pip](https://pypi.org/project/pip/) (v21 or later)
- [pipenv](https://pypi.org/project/pipenv/) (v2021.5 or later)
- [Flask](https://flask.palletsprojects.com/) (v2.0 or later) or [FastAPI](https://fastapi.tiangolo.com/) (v0.68 or later)
- [Scss](https://sass-lang.com/) (v1.37 or later)
- [PostCSS](https://postcss.org/) (v8.3 or later)
- [Lottie](https://lottiefiles.com/) (v5.7 or later)
## 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](src-tauri/tauri.conf.json)
- This contains a npm dependencies [package.json](/package.json)
- This contains a cargo dependencies [src-tauri/cargo.toml](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](https://ui.shadcn.com/docs/installation/next) 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:
- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
- [WebStorm](https://www.jetbrains.com/webstorm/) + [Tauri](https://plugins.jetbrains.com/plugin/16459-tauri) + [Rust](https://plugins.jetbrains.com/plugin/8182-rust)
- [IntelliJ IDEA](https://www.jetbrains.com/idea/) + [Tauri](https://plugins.jetbrains.com/plugin/16459-tauri) + [Rust](https://plugins.jetbrains.com/plugin/8182-rust)
- [Sublime Text](https://www.sublimetext.com/) + [Tauri](https://packagecontrol.io/packages/Tauri) + [Rust Enhanced](https://packagecontrol.io/packages/Rust%20Enhanced)
- [Atom](https://atom.io/) + [Tauri](https://atom.io/packages/tauri) + [ide-rust](https://atom.io/packages/ide-rust)
- [Jet Brains Rover (Early Access)](https://www.jetbrains.com/rover/) + [Tauri](https://plugins.jetbrains.com/plugin/16459-tauri) + [Rust](https://plugins.jetbrains.com/plugin/8182-rust)
## License
This project is licensed under the GNU General Public License v3.0. See [LICENSE](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](CODE_OF_CONDUCT.md). 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](https://github.com/muhammad-fiaz/MaaagicUI#star-the-project): Show your support by giving the project a star ⭐ on GitHub.
- [Contribute](https://github.com/muhammad-fiaz/MaaagicUI#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](https://github.com/muhammad-fiaz/MaaagicUI#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](https://github.com/muhammad-fiaz/MaaagicUI#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.
[](https://github.com/sponsors/muhammad-fiaz)
Your contributions, feedback, and support are immensely valuable to us. Thank you for being a part of the Maaagic UI community!