TABLE OF CONTENTS

• Demo
• Features
• Installation
  • Manual installation
  • Docker installation
• Components documentation
• Console commands
• Testing
• FAQ
• How to contribute?
• Have any questions?

Quickstart

1. Install composer
2. Install docker
3. Install docker-compose
4. Run

   composer create-project yii2-starter-kit/yii2-starter-kit myproject.com --ignore-platform-reqs
   cd myproject.com
   composer run-script docker:build

5. Go to http://yii2-starter-kit.localhost

FEATURES

Admin backend

• Beautiful and open source dashboard theme for backend AdminLTE 3
• Content management components: articles, categories, static pages, editable menu, editable carousels, text blocks
• Settings editor. Application settings form (based on KeyStorage component)
• File manager
• Users, RBAC management
• Events timeline
• Logs viewer
• System monitoring

Development tasks

To list all available development tasks follow these steps:

1. Install taskctl task runner
2. Run taskctl

I18N

• Built-in translations:
  • English
  • Spanish
  • Russian
  • Ukrainian
  • Chinese
  • Vietnamese
  • Polish
  • Portuguese (Brazil)
  • Indonesian (Bahasa)
• Language switcher, built-in behavior to choose locale based on browser preferred language
• Backend translations manager

Users

• Sign in
• Sign up
• Profile editing(avatar, locale, personal data)
• Optional activation by email
• OAuth authorization
• RBAC with predefined guest, user, manager and administrator roles
• RBAC migrations support

Development

• Ready-to-use Docker-based stack (php, nginx, mysql, mailcatcher)
• .env support
• Webpack build configuration
• Key-value storage service
• Ready to use REST API module
• File storage component + file upload widget
• On-demand thumbnail creation trntv/yii2-glide
• Built-in queue component yiisoft/yii2-queue
• Command Bus with queued and async tasks support trntv/yii2-command-bus
• ExtendedMessageController with ability to replace source code language and migrate messages between message sources
• Some useful shortcuts

Other

• Useful behaviors (GlobalAccessBehavior, CacheInvalidateBehavior)
• Maintenance mode support (more)
• Aceeditor widget
• Datetimepicker widget,
• Imperavi Reactor Widget,
• Xhprof Debug panel
• Sitemap generator
• Extended IDE autocompletion
• Test-ready
• Docker support and Vagrant support
• Built-in mailcatcher
• Swagger for API docs.

administrator role account

Login: webmaster
Password: webmaster

manager role account

Login: manager
Password: manager

user role account

Login: user
Password: user

READ MORE

• Yii2
• Docker