Giter Club home page Giter Club logo

enso's Introduction

Laravel Enso

StyleCI Stories in In Progress

Hit the ground running when building your new Laravel project with boilerplate and extra functionality out of the box!

 

Official Documentation

Check out the official documentation here.

Demo

Demo application, just login with user: [email protected] and password: password

Installation Steps

  1. Download the project with git clone https://github.com/laravel-enso/Enso.git

  2. Run in the project folder composer install

  3. Configure .env file. Run php artisan key:generate

  4. Run php artisan migrate

  5. Login into the project with user: [email protected], password: password

  6. (optional) Setup the config/laravel-enso.php file

  7. (optional) npm install / npm run dev

Enjoy!

With enso you get

  • Customizable and powerful data-tables:
    • server side, with multi-argument,
    • full column search
    • sublime snippet for table template
    • server-side excel export for every tables - coming soon
  • Bootstrap select - server side builder with parameters conditioning, including pivot parameters
  • Advanced owner / roles / permissions structure
  • Log management - view, download, clear
  • User action logger, so you can keep track of who's done what
  • User impersonation function, via middleware
  • Bootstrap Tour powered tutorials
  • Localisation support
  • Charts component with server side data builder
  • Comments component with support for tagging users
  • Documents component with upload, download and inline view
  • Ability to track who created, updated and deleted models, using traits
  • File uploader and file management library with VueJS front end component
  • Avatar functionality for all users
  • Ability to track the different versions of a model through its lifetime
  • Front-end date-picker, time-picker and type-ahead components VueJS
  • User application preferences - every user has the ability to choose his theme (from 10 variants), set the menu style, app language and more
  • Queueable jobs
  • Push notifications - working out of the box (requires Pusher)
  • Automatic breadcrumbs generation
  • Application-wide timestamp formatting customization through the configuration file
  • many more helpers and hidden gems

fully working in less than 5 minutes!

     

Under the Hood

Authentication

  • the standard Laravel authentication is used, via email & password

Authorization

  • application wide, checking user status: active/inactive. The check is made for every request, via a middleware. The inactive status prevents the user from logging in and making requests. If an user becomes inactive while he's still logged in, at his next request he'll be logged out and redirected to the login page with a notification
  • application-section wide, via the menu visibility, depending on the user's role. The users that don't have access to a certain menu, can't see it. The check is made before each menu redraw. This level doesn't block access to the routes, it just affects the visibility of the menus
  • application-section wide, depending on permitted access to routes, which is tied to the user's role and the associated permissions for that role. The check is made for each request, via a middleware. If the user is not allowed on a route a 403 response is given back and a laravel.log entry is made.
  • content specific, via gates & policies. The check is made locally, when and where gates & policies are used

Middleware & Middleware Groups

  • for the routes within the application, the 'core' middleware group is applied
  • the 'core' group contains the middleware below, presented in the order they're applied:
    • verify-active-state - checks users's status (active/inactive)
    • action-logger - logs for each request the user's id, route, url, the HTTP verb and the timestamps
    • verify-route-access - authorizes the access to a route
    • impersonate - starts and stops the impersonation of a user, when needed
    • set-language - sets the user's chosen language (localisation)

Owners, Roles & Users

  • users represent the operators using the application
  • roles are collections of permissions
  • owners are user groups, and can represent departments, types, and even companies
  • an owner can have many users
  • an owner can have many roles
  • an user has just one owner and just one role
  • the role of a user may only be one of the roles available for its owner
  • users have an active or inactive status, where inactive users cannot login or make requests into the application (but can set/reset their password)

Preferences

The mechanism allows saving and loading upon every request the user's preferences for several aspects of the application.

  • the preferences can be updated from the right-hand sidebar. From here the user can also reset the preferences to default.
  • the user's preferences are store in the preferences table, under value column in JSON format.
  • list of preferences
    • lang - the user's language
    • theme - the currently selected theme
    • dtStateSave - flag for saving the state/preferences for each data-table within the application (for up to 90 days)
    • fixedHeader - flag for setting the header fixed or scrollable
    • collapsedSidebar - flag for setting the starting position of the main sidebar extended or collapsed

Environment

  • config
    • within the configuration file config/larave-enso.php various options may be set, such as the folders used for storing uploads, avatars, etc. the caching duration and the timestamps format when displaying them

Telemetry

  • the implicit login event that Laravel fires on a user's login triggers a listener that stores the user's ip, user-agent and timestamps inside the logins table

Exceptions

  • where needed, EnsoException instances are thrown. \EnsoException is also a Facade.
  • depending on the type of the request (ajax or non ajax) a different response is returned

Thanks

Built with with ❤️, crafted on Laravel 5.4, Bootstrap 3.3.7, Vuejs 2.x and:

AdminLTE, DataTables, Bootswatch Paper, Chartjs, Font awesome, Toastr.js, Particles.js, Nprogress.js, Bootstrap Tour, Bootstrap Select, Bootstrap Datepicker

Special thanks to Taylor Otwell, Jeffrey Way, Evan You, Allan Jardine and Abdullah Almsaeed.

Contributions

are welcome. Pull requests are great, but issues are good too.

License

This package is released under the MIT license.

enso's People

Contributors

aocneanu avatar gandesc avatar waffle-iron avatar

Watchers

James Cloos avatar Arie Fitriadin avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.