Skip to content
This repository was archived by the owner on Sep 1, 2023. It is now read-only.
/ notrac-admin Public archive

Notrac administrator CMS: Take control over content in a simple & elegant way.

Notifications You must be signed in to change notification settings

dj-idfx/notrac-admin

Repository files navigation

Notrac Admin

Notrac administrator CMS: Take control over content in a simple & elegant way.

Quick guide for local development:

  • Clone the GitHub repo
  • Install composer dependencies: composer install
  • Update .env file (app key, database, mail, ...)
  • Install node packages and build: npm install && npm run build
    When using Powershell terminal: npm install; npm run build
  • Migrate database: php artisan migrate
  • Optional db seed: php artisan db:seed
  • Run local hosting: php artisan serve
    When using Laragon or another local server go to https://notrac-admin.local

created with:

  • Laravel 9: the PHP Framework for Web Artisans
  • Bootstrap 5: the most popular HTML, CSS, and JS library in the world.

Composer packages

Install packages defined in the composer.json file. All files will be placed inside the vendor directory:

composer install 

Check out this overview of cool packages I used for this project:

Barry vd. Heuvel - IDE Helper Generator

Complete PHPDocs, directly from the source.
Package is registered in AppServiceProvider, settings can be found in the ide-helper.php file inside the config folder.
Docs are generated automatically after running composer install
Barry Github
composer require --dev barryvdh/laravel-ide-helper

Laravel - Breeze

Authentication scaffolding for Laravel (Controllers, Requests & Views).
Official documentation
composer require --dev laravel/breeze

OPcodes - Log Viewer

Log Viewer helps you quickly and clearly see individual log entries,
to search, filter, and make sense of your Laravel logs fast.
Official documentation
Opcodesio Github
composer require opcodesio/log-viewer

Spatie - Laravel Honeypot

Preventing spam submitted through forms.
Settings can be found in the honeypot.php file inside the config folder.
Spatie Github
composer require spatie/laravel-honeypot

Spatie - Laravel Media Library

Associate files with Eloquent models.
Settings can be found in the media-library.php file inside the config folder.
Official documentation
Spatie Github
composer require spatie/laravel-medialibrary

Spatie - Laravel Permission

Associate users with permissions and roles.
Settings can be found in the permission.php file inside the config folder.
Official documentation
Spatie Github
composer require spatie/laravel-permission

Spatie - Laravel Sluggable

Generate a unique slug when saving any Eloquent model.
Spatie Github
composer require spatie/laravel-sluggable

The Laravel Collective - HTML

HTML and Form Builders.
Official documentation
LaravelCollective Github
composer require laravelcollective/html


NPM packages

Get the packages defined in the package.json file, they will be installed in the node_modules directory.
After that run the front-end resources build process with Vite.

npm install  
npm run build

Please go through this list of extra packages I used for this project:

Bootstrap 5 + Icons

Powerful, extensible, and feature-packed frontend toolkit.
Official website
npm i --save bootstrap @popperjs/core
npm i --save-dev sass npm i bootstrap-icons

Quill

Your powerful rich text editor.
Official website
npm install quill

Dropzone

A JavaScript library to add file drag and drop functionality to web forms
Official website
npm install dropzone

Chocolat

Responsive image lightbox
Official website
Official documentation
npm install chocolat

About

Notrac administrator CMS: Take control over content in a simple & elegant way.

Topics

Resources

Stars

Watchers

Forks