anax/anax

The Anax framework.

Anax

, _(*1)

, _(*2)

The base for a complete installation of Anax with all the basic features. Use this to get going with your Anax project., _(*3)

Table of Content

• Requirements
• Install
• Verify installation
• Post installation
• CLI-utility anax
• License

Requirements

You need:, _(*4)

• PHP 7.2 or later
• composer
• git

You might want to have:, _(*5)

• A webserver with PHP enabled.
• make
• node and npm to work with the theme/.
• Docker and docker-compose to run in containers.

Install

There are different ways on how to get going and install a fresh installation of the framework. They all include the following tasks:, _(*6)

1. Get a copy of this repo.
2. Do composer install to get all dependencies.
3. Execute all|some scaffolding scripts .anax/*.d/*.bash.

Composer

This is the prefered way since it only requires the use of composer., _(*7)

Composer automatically installs in the directory site/ with the dependencies and processes all the scaffolding scripts., _(*8)

composer create-project anax/anax site --stability beta

You might want to use the switch --ignore-platform-reqs if your cli environment is different from your apache environment., _(*9)

Git clone

This might be useful during development., _(*10)

Clone this repo into a folder site/ and perform composer install and finish up by executing all of the scaffolding scripts., _(*11)

git clone https://github.com/canax/anax.git site
cd site
composer install
composer run-script post-create-project-cmd

Scaffolding from Anax components

If you want a more customized installation you could decide on what postprocessing scripts you want to execute post the installation., _(*12)

First, install the source and install the components using composer install., _(*13)

composer create-project anax/anax site --stability beta --no-scripts
# or
git clone https://github.com/canax/anax.git site
cd site
composer install

Then you can manually execute the scaffold script., _(*14)

bash .anax/anax.bash version
bash .anax/anax.bash help
ls -d .anax/*.d
# See the available commands
bash .anax/anax.bash scaffold theme cimage

These are the basic parts of scaffolding., _(*15)

You should remove the .anax directory once you have scaffolded your site. Executing scaffolding repeated times is not guaranteed to work and may corrupt your installation., _(*16)

Verify installation

These are steps you can carry out to verify your installation., _(*17)

Open your site in a web browser

Point your web browser to the directory site/htdocs., _(*18)

Open your site, through docker, in a web browser

Start the docker container., _(*19)

docker-compose up website

Point your web browser to http://localhost:8088/., _(*20)

Install development environment and run tests

The repo comes with a development environment which can be installed and the tests can be executed., _(*21)

make install test

Run make to see what more can be done., _(*22)

Post installation

Here are more tasks to carry out to enhance your installation., _(*23)

Suggested add-ons

Check what other packages that might be suggested. These are not essential, just suggestions. You can leave them as is for now., _(*24)

composer suggests --no-dev --by-package

CLI-utility anax

When working with an anax installation you might want to opt to use the anax-cli (anax/anax-cli) to aid in scaffolding ordinary components., _(*25)

You can install anax cli like this., _(*26)

composer require anax/anax-cli

You can then execute it like this., _(*27)

vendor/bin/anax.bash --help

License

This software carries a MIT license. See LICENSE.txt for details., _(*28)

 .  
..:  Copyright (c) 2013 - 2020 Mikael Roos, mos@dbwebb.se