mirror of
https://github.com/mivodev/mivo.git
synced 2026-01-26 05:25:42 +07:00
Initial Release v1.0.0: Full feature set with Docker automation, Nginx/Alpine stack
This commit is contained in:
78
README.md
Normal file
78
README.md
Normal file
@@ -0,0 +1,78 @@
|
||||
<p align="center">
|
||||
<img src="public/assets/img/logo.png" alt="MIVO Logo" width="200" />
|
||||
</p>
|
||||
|
||||
# MIVO (Mikrotik Voucher)
|
||||
|
||||
> **Modern. Lightweight. Efficient.**
|
||||
|
||||
MIVO is a complete rewrite of the legendary **Mikhmon v3**, re-engineered with a modern MVC architecture to run efficiently on low-end devices like STB (Set Top Boxes) and Android, while providing a premium user experience on desktop.
|
||||
|
||||
  
|
||||
|
||||
## 🚀 Key Features
|
||||
|
||||
* **⚡ Lightweight Core**: Built on a custom minimal MVC framework (~50KB core) optimized for speed.
|
||||
* **🎨 Modern UI/UX**: Fresh Glassmorphism design system using TailwindCSS and Alpine.js.
|
||||
* **📱 Responsive**: Fully optimized mobile experience with touch-friendly navigation.
|
||||
* **🔒 Secure**: Environment-based configuration (`.env`), encrypted credentials, and secure session management.
|
||||
* **🔌 API Ready**: Built-in REST API support with CORS management for external integrations.
|
||||
* **🛠️ CLI Tool**: Includes `mivo` CLI helper for easy management and installation.
|
||||
|
||||
## 🛠️ Installation
|
||||
|
||||
### Requirements
|
||||
* PHP 8.0 or higher
|
||||
* SQLite3 Extension
|
||||
* OpenSSL Extension
|
||||
|
||||
### Quick Start
|
||||
|
||||
1. **Clone the Repository**
|
||||
```bash
|
||||
git clone https://github.com/dyzulk/mivo.git
|
||||
cd mivo
|
||||
```
|
||||
|
||||
2. **Setup Environment**
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
3. **Install & Generate Key**
|
||||
```bash
|
||||
php mivo install
|
||||
```
|
||||
*This will create the database, run migrations, generate your secure `APP_KEY`, and set up the admin account.*
|
||||
|
||||
4. **Run Development Server**
|
||||
```bash
|
||||
php mivo serve
|
||||
```
|
||||
Access the app at `http://localhost:8000`.
|
||||
|
||||
## 📂 Structure
|
||||
|
||||
* `app/` - Core application logic (Controllers, Models, Views).
|
||||
* `public/` - Web root and assets.
|
||||
* `routes/` - Route definitions (`web.php`, `api.php`).
|
||||
* `mivo` - CLI executable entry point.
|
||||
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
Contributions are welcome! Please feel free to submit a Pull Request.
|
||||
|
||||
## ☕ Support the Project
|
||||
|
||||
If you find MIVO useful, please consider supporting its development. Your contribution helps keep the project alive!
|
||||
|
||||
[](https://sociabuzz.com/dyzulkdev/tribe)
|
||||
|
||||
|
||||
## 📄 License
|
||||
|
||||
This project is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
|
||||
|
||||
---
|
||||
*Created with ❤️ by DyzulkDev*
|
||||
Reference in New Issue
Block a user