honeybee/honeybee-agavi-cmf-project

Project (template) for building content-management applications, based on Agavi and the Honeybee CQRS library.

Maintainers

Details

github.com/honeybee/honeybee-agavi-cmf-project

Homepage

Source

Issues

IRC

Installs: 23

Dependents: 0

Suggesters: 0

Security: 0

Stars: 9

Watchers: 8

Forks: 2

Open Issues: 1

Language:Ruby

Type:project

dev-master 2016-08-26 10:35 UTC

Requires

Requires (Dev)

MIT 5f4ef21e70efd55eb66e1c5f87a643dd9cfdb330

honeybeeagaviproject-template

This package is auto-updated.

Last update: 2024-12-05 19:11:52 UTC

README

The Honeybee-Agavi Content Management Framework (CMF) is based on the Honeybee CQRS and Event Sourcing library which includes framework bindings for the Agavi MVC framework. It provides a modular and scalable application infrastructure to facilitate construction of sophisticated content managment systems (CMS) while supporting a Domain Driven Design (DDD) methodology.

This project is in active development. Changes may be frequent until releases are provided.

#Installation

Installation of an application can be done directly from this project repository following the instructions provided.

##Installing the application inside a VM

These instructions detail the procedure for boostrapping your application on a virtual machine (VM). The VM will be provisioned and configured with the required environment for Honeybee applications.

###Prerequisites

###Creating a new project

Creating a project with composer will guide you through configuring a project and VM for a new application. We ignore platform requirements because the project will be installed inside the VM.

# replace the last argument with your chosen folder name if required
composer create-project -sdev --ignore-platform-reqs --no-install \
honeybee/honeybee-agavi-cmf-project honeybee-agavi-cmf-project

The repository will be cloned and a post-install script will be executed which will prompt you with some simple configuration questions.

  • When asked for a Github repository you should pick a repository name that you have write access to and is accessible by your VM. Your application will need to be pushed to this repository so the VM can launch, clone and install.
  • When asked to configure a VM you should answer yes
  • When asked for a hostname, you can accept the default based on your repository name or choose another HTTPS URL instead, where your application will be hosted inside the VM.
  • When asked by composer if you wish to keep the VCS files, you may answer no

###Initialising your repository

Your application is now configured and ready for committing to your own repository. Detailed instructions on creating new repositories on Github from source can be found here. We have summarised the commands as follows:

# first create repository at Github
cd honeybee-agavi-cmf-project
git init
git add .
git commit -m 'Initialising project'
# replace the following Github repository url with your own
git remote add origin git@github.com:honeybee/honeybee-agavi-cmf-project.git
git push -u origin master

###Launching the VM

When your new repository is publicly available, the VM is ready to launch. When the VM is first initialised, it will clone the Github repository you just created. You can start the machine with the following commands:

# ensure VirtualBox guest additions are installed!
# vagrant plugin install vagrant-vbguest
cd honeybee-agavi-cmf-project/dev/box
vagrant up
# please wait, the virtual machine will be downloaded and installed
# provisioning can take up to 30 minutes depending on resources

You will see console output as the machine image is downloaded and provisioned. During the provisioning you maybe prompted for input and can accept the default in all cases.

###Completing installation

When your VM is up and running you can finish installation by executing the following commands:

vagrant ssh
cd /srv/www/honeybee-agavi-cmf-project.local
composer install 
# when prompted you should accept the project installation
sudo service nginx restart

The application will install all dependencies and build all required resources. This may take several minutes.

###Accessing the CMS

When successfully setup the application should be accessible at:

https://honeybee-agavi-cmf-project.local/

At this point it is ready for use and development, however it will not contain any data at this point. If you have not created a Honeybee application before we recommend that you review the cookbook. The cookbook will guide you through the creation of a demo application from scratch, explaining many of the concepts you will need to know to build applications on this framework.

Alternatively you may wish to intialise the application from scratch as explained here.

###Mounting the source

  • Mac OSX:
    • In the Finder menu:
      • Select Connect to Server... (⌘K)
      • Enter the following address: nfs://honeybee-agavi-cmf-project.local/srv/www/
  • Ubuntu/Linux:
    • mount honeybee-agavi-cmf-project.local:/srv/www/ /home/${USER}/projects/honeybee-agavi-cmf-project

###Controlling system services

The following main services are running on the VM and are controlled via systemd:

In order to start/stop services or get the status, use the corresponding sudo command within the VM.

sudo systemctl status|start|stop|restart couchdb|elasticsearch|converjon

Turning the VM on/off

Whenever possible stop the box with:

vagrant suspend

and wake it up again using:

vagrant resume

This will send the box asleep, instead of completely shutting it off and thus runs faster. The box's network interfaces are not reconfigured using suspend/resume though. For this the virtual machine needs to be completely rebooted, which can be done by calling:

vagrant reload # is the same as: vagrant halt && vagrant up

##Installation locally

Coming soon...

##Initialisation

When a Honeybee CMF project is first installed, the databases are not initialised and there is no data in the system.

###Initialising the stores

System migrations are provided for creating administration users. We can execute all pending migrations and initialise the data stores using the following command:

composer migration-run -- --all

On completion you will see a summary of which migrations were executed. There is no data in the system at this point.

###Creating an administrative user

We can create an administration user with the following command.

composer user-create

The command will prompt for a user name and email address. Enter your choices following the command instructions, then follow instructions for setting a password. You may then login to the system at https://honeybee-agavi-cmf-project.local/ with your newly created account.

######User registration and email services In normal user registration flows, users are sent account verification emails. In a development environment the mail service is stubbed and will not actually send emails.