Skip to content

NaLogo/yii2-starter-kit

 
 

Repository files navigation

Yii 2 Starter Kit

Packagist Packagist Build Status

This is Yii2 start application template.

It was created and developing as a fast start for building an advanced sites based on Yii2.

It covers typical use cases for a new project and will help you not to waste your time doing the same work in every project

This fork is a version of the Yii2 starter kit with a few smaller updates and a bit of tailoring towards using it with Vagrant exclusively.

It's for personal use first and foremost but maybe this is useful to someone else, too. :)

Before you start

Please, consider helping project via contributions or donations.

TABLE OF CONTENTS

Quickstart

  1. Install Vagrant

  2. Copy ./vagrant/vagrant.yml.dist to ./vagrant/vagrant.yml

  3. Copy ./.env.dist to ./.env

  4. Create GitHub personal API token

  5. Edit values as desired including adding the GitHub personal API token to ./vagrant/vagrant.yml

  6. Edit domains as desired in ./.env

    If you edit domains in ./.env, you need to make appropriate changes to ./vagrant/vhost.conf and ./Vagrantfile

  7. Run:

vagrant plugin install vagrant-hostmanager
vagrant up

That`s all. After provision application will be accessible on 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

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

Other

DEMO

administrator role account

Login: webmaster
Password: webmaster

manager role account

Login: manager
Password: manager

user role account

Login: user
Password: user

How to contribute?

You can contribute in any way you want. Any help appreciated, but most of all i need help with docs (^_^)

Have any questions?

Mail to [email protected] or [email protected]

Why did you remove Docker support?

More of a personal choice. I pretty much exclusively use Windows and frankly, Docker is an absolute nightmare on Windows. Neither the kind-of deprecated Docker Toolbox nor the "new and improved" Docker for Windows work properly when volumes come into play. In comparison, Vagrant has been very easy to use. Sure, some small changes (like I made in this fork) were necessary. But this is a far cry from what is usually necessary to get a docker-compose system set up on a Windows host.

READ MORE

NOTE

This template was created mostly for developers NOT for end users. This is a point where you can start your application, rather than creating it from scratch. Good luck!

About

Yii2 Starter Kit

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 97.8%
  • Other 2.2%