mirror of
https://github.com/MikroWizard/mikrofront.git
synced 2025-08-03 09:44:43 +02:00
Update Readme
This commit is contained in:
sepehr
parent
b97aec6b97
commit
c656a1be58
1 changed files with 27 additions and 194 deletions
221
README.md
221
README.md
|
|
@ -1,222 +1,55 @@
|
|||
[](https://github.com/coreui/angular)
|
||||
[![npm-coreui-angular][npm-coreui-angular-badge]][npm-coreui-angular]
|
||||
[![NPM downloads][npm-coreui-angular-download]][npm-coreui-angular]
|
||||
[](https://github.com/coreui/coreui)
|
||||
[![npm package][npm-coreui-badge]][npm-coreui]
|
||||
[![NPM downloads][npm-coreui-download]][npm-coreui]
|
||||
|
||||
|
||||
[npm-coreui-angular]: https://www.npmjs.com/package/@coreui/angular
|
||||
[npm-coreui-angular-badge]: https://img.shields.io/npm/v/@coreui/angular.png?style=flat-square
|
||||
[npm-coreui-angular-badge-next]: https://img.shields.io/npm/v/@coreui/angular/next?style=flat-square&color=red
|
||||
[npm-coreui-angular-download]: https://img.shields.io/npm/dm/@coreui/angular.svg?style=flat-square
|
||||
[npm-coreui]: https://www.npmjs.com/package/@coreui/coreui
|
||||
[npm-coreui-badge]: https://img.shields.io/npm/v/@coreui/coreui.png?style=flat-square
|
||||
[npm-coreui-download]: https://img.shields.io/npm/dm/@coreui/coreui.svg?style=flat-square
|
||||
# MikroFront | MikroWizard Front
|
||||
|
||||
# CoreUI Free Admin Dashboard Template for Angular 16
|
||||
|
||||
CoreUI is meant to be the UX game changer. Pure & transparent code is devoid of redundant components, so the app is light enough to offer ultimate user experience. This means mobile devices also, where the navigation is just as easy and intuitive as on a desktop or laptop. The CoreUI Layout API lets you customize your project for almost any device – be it Mobile, Web or WebApp – CoreUI covers them all!
|
||||
This is the MikroWizard Front app based angular and core-ui admin template
|
||||
|
||||
- [CoreUI Angular Admin Dashboard Template & UI Components Library](https://coreui.io/angular)
|
||||
- [CoreUI Angular Demo](https://coreui.io/angular/demo/4.3/free/)
|
||||
- [CoreUI Angular Docs](https://coreui.io/angular/docs/)
|
||||
# What is MikroWizard?
|
||||
|
||||
## Table of Contents
|
||||
Mikrotik routers are widely used in the networking industry for their robust features and flexibility. However, managing and monitoring these routers can be a complex and time-consuming task. With MikroWizard, we aim to simplify this process and empower network administrators with a powerful yet user-friendly tool.
|
||||
|
||||
* [Versions](#versions)
|
||||
* [CoreUI Pro](#coreui-pro)
|
||||
* [Quick Start](#quick-start)
|
||||
* [Installation](#installation)
|
||||
* [Basic usage](#basic-usage)
|
||||
* [What's included](#whats-included)
|
||||
* [Documentation](#documentation)
|
||||
* [Versioning](#versioning)
|
||||
* [Creators](#creators)
|
||||
* [Community](#community)
|
||||
* [Copyright and License](#copyright-and-license)
|
||||
|
||||
## Versions
|
||||
## Features
|
||||
|
||||
* [CoreUI Free Bootstrap Admin Template](https://github.com/coreui/coreui-free-bootstrap-admin-template)
|
||||
* [CoreUI Free Angular Admin Template](https://github.com/coreui/coreui-free-angular-admin-template)
|
||||
* [CoreUI Free React.js Admin Template](https://github.com/coreui/coreui-free-react-admin-template)
|
||||
* [CoreUI Free Vue.js Admin Template](https://github.com/coreui/coreui-free-vue-admin-template)
|
||||
- Router Management
|
||||
- Device grouping
|
||||
- Access Management
|
||||
- Monitoring and Reporting
|
||||
- Automation and Scripting
|
||||
- Snippets ( Batch configuration )
|
||||
- User Access Management
|
||||
- Permission Enforcement
|
||||
- Activity Monitoring
|
||||
for more info please check mikroman repo
|
||||
|
||||
## CoreUI Pro
|
||||
|
||||
**Only customers with [Enterpise Membership Plan](https://coreui.io/pro/#buy) have access to private GitHub CoreUI Pro repository.**
|
||||
## License
|
||||
|
||||
* 💪 [CoreUI Pro Angular Admin Template](https://coreui.io/product/angular-dashboard-template/)
|
||||
* 💪 [CoreUI Pro Bootstrap Admin Template](https://coreui.io/product/bootstrap-dashboard-template/)
|
||||
* 💪 [CoreUI Pro React Admin Template](https://coreui.io/product/react-dashboard-template/)
|
||||
* 💪 [CoreUI Pro Next.js Admin Template](https://coreui.io/product/next-js-dashboard-template/)
|
||||
* 💪 [CoreUI Pro Vue Admin Template](https://coreui.io/product/vue-dashboard-template/)
|
||||
[AGPL](https://www.gnu.org/licenses/agpl-3.0.html)
|
||||
|
||||
## Quick Start
|
||||
|
||||
- [Download the latest release](https://github.com/coreui/coreui-free-angular-admin-template/)
|
||||
- Clone the repo: `git clone https://github.com/coreui/coreui-free-angular-admin-template.git`
|
||||
# MikroFront | MikroWizard Front
|
||||
|
||||
#### <i>Prerequisites</i>
|
||||
Before you begin, make sure your development environment includes `Node.js®` and an `npm` package manager.
|
||||
|
||||
###### Node.js
|
||||
[**Angular 16**](https://angular.io/guide/what-is-angular) requires `Node.js` LTS version `^16.14` or `^18.10`.
|
||||
This is the MikroWizard Front app based angular and core-ui admin template
|
||||
|
||||
- To check your version, run `node -v` in a terminal/console window.
|
||||
- To get `Node.js`, go to [nodejs.org](https://nodejs.org/).
|
||||
# What is MikroWizard?
|
||||
|
||||
###### Angular CLI
|
||||
Install the Angular CLI globally using a terminal/console window.
|
||||
```bash
|
||||
npm install -g @angular/cli
|
||||
```
|
||||
Mikrotik routers are widely used in the networking industry for their robust features and flexibility. However, managing and monitoring these routers can be a complex and time-consuming task. With MikroWizard, we aim to simplify this process and empower network administrators with a powerful yet user-friendly tool.
|
||||
|
||||
### Installation
|
||||
|
||||
``` bash
|
||||
$ npm install
|
||||
$ npm update
|
||||
```
|
||||
## Tech Stack
|
||||
|
||||
### Basic usage
|
||||
**Client:** Angular , CoreUI admin template , Python(Updater script only)
|
||||
|
||||
``` bash
|
||||
# dev server with hot reload at http://localhost:4200
|
||||
$ npm start
|
||||
```
|
||||
**Server:** [mikroman](https://github.com/MikroWizard/mikroman)
|
||||
|
||||
Navigate to [http://localhost:4200](http://localhost:4200). The app will automatically reload if you change any of the source files.
|
||||
|
||||
#### Build
|
||||
## Deployment
|
||||
|
||||
Run `build` to build the project. The build artifacts will be stored in the `dist/` directory.
|
||||
To deploy this project run
|
||||
|
||||
```bash
|
||||
# build for production with minification
|
||||
$ npm run build
|
||||
```
|
||||
## What's included
|
||||
|
||||
Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:
|
||||
|
||||
```
|
||||
coreui-free-angular-admin-template
|
||||
├── src/ # project root
|
||||
│ ├── app/ # main app directory
|
||||
| │ ├── containers/ # layout containers
|
||||
| | │ └── default-layout/ # layout containers
|
||||
| | | └── _nav.js # sidebar navigation config
|
||||
| │ ├── icons/ # icons set for the app
|
||||
| │ └── views/ # application views
|
||||
│ ├── assets/ # images, icons, etc.
|
||||
│ ├── components/ # components for demo only
|
||||
│ ├── scss/ # scss styles
|
||||
│ └── index.html # html template
|
||||
│
|
||||
├── angular.json
|
||||
├── README.md
|
||||
└── package.json
|
||||
....
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
The documentation for the CoreUI Admin Template is hosted at our website [CoreUI for Angular](https://coreui.io/angular/)
|
||||
|
||||
---
|
||||
|
||||
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 15.0.0.
|
||||
|
||||
## Versioning
|
||||
|
||||
For transparency into our release cycle and in striving to maintain backward compatibility, CoreUI Free Admin Template is maintained under [the Semantic Versioning guidelines](http://semver.org/).
|
||||
|
||||
See [the Releases section of our project](https://github.com/coreui/coreui-free-angular-admin-template/releases) for changelogs for each release version.
|
||||
|
||||
## Development server
|
||||
|
||||
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
|
||||
|
||||
## Code scaffolding
|
||||
|
||||
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
|
||||
|
||||
## Build
|
||||
|
||||
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
|
||||
|
||||
## Running unit tests
|
||||
|
||||
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
|
||||
|
||||
## Running end-to-end tests
|
||||
|
||||
Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
|
||||
|
||||
## Further help
|
||||
|
||||
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
|
||||
|
||||
## Creators
|
||||
|
||||
**Łukasz Holeczek**
|
||||
* <https://twitter.com/lukaszholeczek>
|
||||
* <https://github.com/mrholek>
|
||||
* <https://github.com/coreui>
|
||||
|
||||
**CoreUI team**
|
||||
* https://github.com/orgs/coreui/people
|
||||
|
||||
## Community
|
||||
|
||||
Get updates on CoreUI's development and chat with the project maintainers and community members.
|
||||
|
||||
- Follow [@core_ui on Twitter](https://twitter.com/core_ui).
|
||||
- Read and subscribe to [CoreUI Blog](https://coreui.io/blog/).
|
||||
|
||||
## Support CoreUI Development
|
||||
|
||||
CoreUI is an MIT-licensed open source project and is completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing. You can support development by buying the [CoreUI PRO](https://coreui.io/pricing/) or by becoming a sponsor via [Open Collective](https://opencollective.com/coreui/).
|
||||
|
||||
<!--- StartOpenCollectiveBackers -->
|
||||
|
||||
### Platinum Sponsors
|
||||
|
||||
Support this project by [becoming a Platinum Sponsor](https://opencollective.com/coreui/contribute/platinum-sponsor-40959/). A large company logo will be added here with a link to your website.
|
||||
|
||||
<a href="https://opencollective.com/coreui/contribute/platinum-sponsor-40959/checkout"><img src="https://opencollective.com/coreui/tiers/platinum-sponsor/0/avatar.svg?avatarHeight=100"></a>
|
||||
|
||||
### Gold Sponsors
|
||||
|
||||
Support this project by [becoming a Gold Sponsor](https://opencollective.com/coreui/contribute/gold-sponsor-40960/). A big company logo will be added here with a link to your website.
|
||||
|
||||
<a href="https://opencollective.com/coreui/contribute/gold-sponsor-40960/checkout"><img src="https://opencollective.com/coreui/tiers/gold-sponsor/0/avatar.svg?avatarHeight=100"></a>
|
||||
|
||||
### Silver Sponsors
|
||||
|
||||
Support this project by [becoming a Silver Sponsor](https://opencollective.com/coreui/contribute/silver-sponsor-40967/). A medium company logo will be added here with a link to your website.
|
||||
|
||||
<a href="https://opencollective.com/coreui/contribute/silver-sponsor-40967/checkout"><img src="https://opencollective.com/coreui/tiers/gold-sponsor/0/avatar.svg?avatarHeight=100"></a>
|
||||
|
||||
### Bronze Sponsors
|
||||
|
||||
Support this project by [becoming a Bronze Sponsor](https://opencollective.com/coreui/contribute/bronze-sponsor-40966/). The company avatar will show up here with a link to your OpenCollective Profile.
|
||||
|
||||
<a href="https://opencollective.com/coreui/contribute/bronze-sponsor-40966/checkout"><img src="https://opencollective.com/coreui/tiers/bronze-sponsor/0/avatar.svg?avatarHeight=100"></a>
|
||||
|
||||
### Backers
|
||||
|
||||
Thanks to all the backers and sponsors! Support this project by [becoming a backer](https://opencollective.com/coreui/contribute/backer-40965/).
|
||||
|
||||
<a href="https://opencollective.com/coreui/contribute/backer-40965/checkout" target="_blank" rel="noopener"><img src="https://opencollective.com/coreui/backers.svg?width=890"></a>
|
||||
|
||||
<!--- EndOpenCollectiveBackers -->
|
||||
|
||||
## Copyright and License
|
||||
|
||||
copyright 2017-2023 creativeLabs Łukasz Holeczek.
|
||||
|
||||
|
||||
Code released under [the MIT license](https://github.com/coreui/coreui-free-react-admin-template/blob/master/LICENSE).
|
||||
There is only one limitation you can't re-distribute the CoreUI as stock. You can’t do this if you modify the CoreUI. In the past, we faced some problems with persons who tried to sell CoreUI based templates.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue