Skip to content

Commit

Permalink
Readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
mariojgt committed Dec 3, 2022
1 parent 2e9bd0b commit f4c3995
Showing 1 changed file with 31 additions and 39 deletions.
70 changes: 31 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,44 @@
![image info](https://raw.githubusercontent.com/mariojgt/skeleton-admin/master/Publish/Art/logo.png)

<div style="text-align: center;">
<img src="https://raw.githubusercontent.com/mariojgt/skeleton-admin/main/Publish/Showcase/img1.png" alt="" style="max-width: 100%;" width="400">
<img src="https://raw.githubusercontent.com/mariojgt/skeleton-admin/main/Publish/Showcase/img2.png" alt="" style="max-width: 100%;" width="400">
<img src="https://raw.githubusercontent.com/mariojgt/skeleton-admin/main/Publish/Showcase/img3.png" alt="" style="max-width: 100%;" width="400">
<img src="https://raw.githubusercontent.com/mariojgt/skeleton-admin/main/Publish/Showcase/img4.png" alt="" style="max-width: 100%;" width="400">
</div>
![Logo](https://raw.githubusercontent.com/mariojgt/skeleton-admin/master/Publish/Art/logo.png)

# Welcome to skeleton-admin
This is a base package for Laravel that scaffolds a basic admin panel. It comes with frontend and backend login and two Webpack configs both for them both respectively. Also included is Inertia JS, Tailwind CSS, Vue JS, Daisy UI, GDPR cookie for Laravel. skeleton-admin comes with a generic crud builder ready and easy to use and Two-factor Authentication out of the box. The project still in development, so if you have any suggestion or you want to contribute, please submit an issue on GitHub, thanks!

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D5EJZ3P)
# Skeleton-admin

## Installation
This is a base package for Laravel that scaffolds a basic but powerful admin panel, out of the box comes with both front and back end
Login with 2 different controllers and model for both admin and normal users login, also it comes with a crudbuilder, vite and inersiajs.

First, you need a clean Laravel project, then run the following commands:

```bash
1: composer require mariojgt/skeleton-admin
2: php artisan install:skeleton-admin
```
A config file will be published to the config (skeleton.php) folder where you can update the settings.

By default, this package will come with the requirements below. For more information please see the package.json file.

## Requirements
- [ ] Tailwind CSS.
- [ ] Daisy UI.
- [ ] Inertia JS.
- [ ] Vue JS.
## Badges

## Features
- [ ] Generict Notificaiton.
- [ ] Two-factor Authentication.
- [ ] GDPR Cookie.
- [ ] Generic CRUD Builder.
- [ ] Laravel Multiple Auth Frontend and Backend.
- [ ] 2 Webpack Configs.
- [ ] Vue js 3 with sugar ref enable.
- [ ] Mobile application ready and build out of the box so you have a quick templated.
- [ ] Vite support

## Usage
After installation, you can access `/user/login` or `/admin/login`. The login page will be the same for both frontend and backend, with different logos. Everything in this package can be changed as the files are inside `resources/vendor/skeleton-admin`. Don't forget to run `npm run watch` to update the files as all the controllers are inside the package.
[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
[![version](https://img.shields.io/packagist/v/mariojgt/skeleton-admin?style=for-the-badge)](http://www.gnu.org/licenses/agpl-3.0)

You may need to create a repo for your project to add new functions because the idea is to have a starting point for your project with everything contained in the package.
## Author

- [@mariojgt](https://github.com/mariojgt)


## Installation

## Note
This package was designed to have a strong and simple start point to be as modular as possible, you can update it to meet your needs and don't forget to contribute to the project, thanks!
First you need a FRESH laravel 9 or higher project

```bash
composer require mariojgt/skeleton-admin
php artisan install:skeleton-admin
```
and that all :)
## Screenshots

![App Screenshot](https://raw.githubusercontent.com/mariojgt/skeleton-admin/master/Publish/Showcase/1.png)
![App Screenshot](https://raw.githubusercontent.com/mariojgt/skeleton-admin/master/Publish/Showcase/2.png)
![App Screenshot](https://raw.githubusercontent.com/mariojgt/skeleton-admin/master/Publish/Showcase/3.png)
![App Screenshot](https://raw.githubusercontent.com/mariojgt/skeleton-admin/master/Publish/Showcase/4.png)
![App Screenshot](https://raw.githubusercontent.com/mariojgt/skeleton-admin/master/Publish/Showcase/5.png)

## Support

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D5EJZ3P)

You can also try the mobile application in this link https://github.com/mariojgt/skeleton-pos that was design to work with this application out of the box just update the endpoint and you are all set.

0 comments on commit f4c3995

Please sign in to comment.