PHPackages                             anax/anax - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. anax/anax

ActiveLibrary[Framework](/categories/framework)

anax/anax
=========

The Anax framework, all included.

v2.0.17(5y ago)01.7k↓100%11MITCSSPHP ^7.2

Since May 8Pushed 5y ago1 watchersCompare

[ Source](https://github.com/canax/anax)[ Packagist](https://packagist.org/packages/anax/anax)[ Docs](https://github.com/canax/anax)[ RSS](/packages/anax-anax/feed)WikiDiscussions master Synced today

READMEChangelogDependencies (24)Versions (24)Used By (1)

Anax
====

[](#anax)

[![Latest Stable Version](https://camo.githubusercontent.com/6041c36a9ceb54538ff85bd1fbd06f7f86507a093e69cf1a4ee35341d5fa66a8/68747470733a2f2f706f7365722e707567782e6f72672f616e61782f616e61782f762f737461626c65)](https://packagist.org/packages/anax/anax)[![Join the chat at https://gitter.im/canax/anax](https://camo.githubusercontent.com/86817de655de88b9866cdf21176d7e9c7801dfe95702c11cc63d23076815a5da/68747470733a2f2f6261646765732e6769747465722e696d2f63616e61782f616e61782e737667)](https://gitter.im/canax/anax?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![Build Status](https://camo.githubusercontent.com/7b23666d33265cc87f47435d3f4bc87d947706285f6b651126ecdd527f07e11c/68747470733a2f2f7472617669732d63692e6f72672f63616e61782f616e61782e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/canax/anax)[![CircleCI](https://camo.githubusercontent.com/1782b67b371222905ec51c68c361fbf66b8f9ca4ad6e844b6f56ae3ce0f9f126/68747470733a2f2f636972636c6563692e636f6d2f67682f63616e61782f616e61782e7376673f7374796c653d737667)](https://circleci.com/gh/canax/anax)[![Build Status](https://camo.githubusercontent.com/75e1f8d5b2a52e117cc5ce8144561f952c2e027c82eafa635b905c28c36471ef/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f63616e61782f616e61782f6261646765732f6275696c642e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/canax/anax/build-status/master)

The base for a complete installation of Anax with all the basic features. Use this to get going with your Anax project.

Table of Content
----------------

[](#table-of-content)

- [Requirements](#Requirements)
- [Install](#Install)
- [Verify installation](#Verify-installation)
- [Post installation](#Post-installation)
- [CLI-utility anax](#CLI-utility-anax)
- [License](#License)

Requirements
------------

[](#requirements)

You need:

- PHP 7.2 or later
- `composer`
- `git`

You might want to have:

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

Install
-------

[](#install)

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

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

[](#composer)

This is the prefered way since it only requires the use of composer.

Composer automatically installs in the directory `site/` with the dependencies and processes all the scaffolding scripts.

```
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.

### Git clone

[](#git-clone)

This might be useful during development.

Clone this repo into a folder `site/` and perform composer install and finish up by executing all of the scaffolding scripts.

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

```

### Scaffolding from Anax components

[](#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.

First, install the source and install the components using `composer install`.

```
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.

```
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.

PartPathDetails`scaffold``.anax/scaffold.d`Copy essentials from modules in `vendor/anax/` to setup a complete installation of Anax.`theme``.anax/theme.d`Install a basic theme in `theme/` and build it.`cimage``.anax/cimage.d`Install and setup to use `mosbth/cimage` as part of the website.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.

Verify installation
-------------------

[](#verify-installation)

These are steps you can carry out to verify your installation.

### Open your site in a web browser

[](#open-your-site-in-a-web-browser)

Point your web browser to the directory `site/htdocs`.

### Open your site, through docker, in a web browser

[](#open-your-site-through-docker-in-a-web-browser)

Start the docker container.

```
docker-compose up website

```

Point your web browser to `http://localhost:8088/`.

### Install development environment and run tests

[](#install-development-environment-and-run-tests)

The repo comes with a development environment which can be installed and the tests can be executed.

```
make install test

```

Run `make` to see what more can be done.

Post installation
-----------------

[](#post-installation)

Here are more tasks to carry out to enhance your installation.

### Suggested add-ons

[](#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.

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

```

CLI-utility anax
----------------

[](#cli-utility-anax)

When working with an anax installation you might want to opt to use the anax-cli ([anax/anax-cli](https://packagist.org/packages/anax/anax-cli)) to aid in scaffolding ordinary components.

You can install anax cli like this.

```
composer require anax/anax-cli

```

You can then execute it like this.

```
vendor/bin/anax.bash --help

```

License
-------

[](#license)

This software carries a MIT license. See [LICENSE.txt](LICENSE.txt) for details.

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

```

###  Health Score

32

—

LowBetter than 74% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity16

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity67

Established project with proven stability

 Bus Factor1

Top contributor holds 98.5% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~41 days

Total

23

Last Release

1976d ago

Major Versions

v1.0.3 → v2.0.0-beta.12019-12-13

### Community

Maintainers

![](https://www.gravatar.com/avatar/4cac244120f54c02a4fb3186b91323f3f0805dd9daefd0babeb4a82a19232faf?d=identicon)[mikael\_roos](/maintainers/mikael_roos)

---

Top Contributors

[![mosbth](https://avatars.githubusercontent.com/u/169550?v=4)](https://github.com/mosbth "mosbth (65 commits)")[![gitter-badger](https://avatars.githubusercontent.com/u/8518239?v=4)](https://github.com/gitter-badger "gitter-badger (1 commits)")

---

Tags

frameworkanax

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/anax-anax/health.svg)

```
[![Health](https://phpackages.com/badges/anax-anax/health.svg)](https://phpackages.com/packages/anax-anax)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
