Skip to content

Latest commit

 

History

History
125 lines (84 loc) · 3.58 KB

README.md

File metadata and controls

125 lines (84 loc) · 3.58 KB
Raw

hotCoffee Admin Panel

☕ Laravel 7 admin panel package to kick start your new web app.

🛠️ Created by Taffo Velikoff (TAVVO Ltd.), Bulgaria.

alt text

Computer psd created by rawpixel.com - www.freepik.com

Contents

🤔 What is hotCoffee?

💻 Requirements

⚙️ Installation

📚 Documentation

📜 TO DO LIST

What is hotCoffee?

HotCoffee is a free Laravel admin interface package. It includes a few "modules" for:

  • Articles/Blog Posts
  • Info Pages
  • Admin Search
  • XLS/CSV Export
  • Menu Builder
  • File Manager
  • User Roles
  • Users
  • Thumbnail Viewer
  • Global Website Settings
  • Custom Search Engine Friendly URLs (SEF URLs) for models
  • and more!

HotCoffee aims to help you with the generic tasks of creating an admin panel and lets you focus on building the app. The admin panel is easily extendable and you can edit most of it's appearance from a single config file.

This package is not a CMS (or blogging system), but it could be used in building one.

Screenshots

User Profile

alt text

Page Editor

alt text

Menu Editor

alt text

Requirements

Before installing hotCoffee make sure you have installed Laravel 7.0 or above and PHP 7.2 or newer.

Installation

🟢 STEP 1: Required the package

The installation process is really simple. Create a new Laravel application and include the package with the following command:

composer require taffovelikoff/hotcoffee

🟢 STEP 2: Setup the database

Next make sure to create a new database and add your database credentials to the .env file. Also add your application URL in the APP_URL variable:

APP_URL=http://127.0.0.1:8000/
DB_HOST=localhost
DB_DATABASE=hotcoffee
DB_USERNAME=root
DB_PASSWORD=mypassword

🟢 STEP 3: Run the installation script

After that you can run an artisan command to finilize the installation.

php artisan hotcoffee:install

The script will ask you if you want to also install the example logic (this includes some example controllers, routes, views and dummy pages for the front-end of your app). Type "yes" or "no" and hit enter to continue.

🟢 STEP 4: Extend the User model

Edit your User model (usually app/User.php) and make the class extend \TaffoVelikoff\HotCoffee\User instead of Authenticatable.

<?php

namespace App;


class User extends \TaffoVelikoff\HotCoffee\User
{
    //
}

🟢 STEP 5: Create your first admin user

You can now create your first admin user with a simple artisan command:

php artisan hotcoffee:make-admin --name=admin [email protected]

🟢 STEP 6: Make sure everything went ok

Use php artisan serve to run PHP's built-in development server. The admin panel should be available on this address (or similar): http://127.0.0.1:8000/admin/login Login with your admin credential.

👏 That's it!

Documentation

You can read the full documentation on https://taffo.gitbook.io/hotcoffee/

License

The MIT License (MIT). Please see License File for more information.

To Do

⭕ Translatable fields view/helper function for the settings page ⭕ Unit tests