KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agent #developer-tools #codex #typescript #cli #deepseek-harness #claude-code #ai-agents #mcp #rust

joomlatools-platform

★ 33 Open GitHub ↗

Modern Joomla developer stack.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Joomlatools Platform
======================

[![Alt text for your video](http://img.youtube.com/vi/1Gt_eln1mUU/0.jpg)](http://www.youtube.com/watch?v=1Gt_eln1mUU)

Would you be willing to trade all the days from this day forward for one chance
-- just one chance -- to come back here and tell our enemies that they
may take our lives, but they'll never take our freedom?

Alba gu bràth!

---

[Joomlatools Platform] is a modern Joomla stack that helps you get started with the best development tools and project
structure.

Much of the philosophy behind the platform is inspired by the [Twelve-Factor App](http://12factor.net/) methodology
including the [Joomla specific version](https://www.joomlatools.com/developer/platform/).

> Forked from [Joomla CMS v3.6.5](https://github.com/joomla/joomla-cms/releases/tag/3.6.5)

## Features

* Better directory structure
* Slimmed down codebase
* Additional flexibility improvements and bug fixes
* Dependency management with [Composer](http://getcomposer.org)
* Easy Joomla configuration with environment specific files
* Environment variables with [Dotenv](https://github.com/vlucas/phpdotenv)
* CLI extension installer with [Joomlatools Composer](http://github.com/joomlatools/joomlatools-composer)

Use the [Joomlatools Vagrant](https://github.com/joomlatools/joomlatools-vagrant) box for additional features:

* Easy development environments with [Vagrant](http://www.vagrantup.com/)
* Easy server provisioning with [Puppet](https://puppetlabs.com/) (Ubuntu 14.04, PHP 5.5, MariaDB)
* One-command deploys using [Capistrano](http://capistranorb.com/)

## Requirements

* PHP >= 7
* Composer - [Install](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx)
* Mbstring PHP Extension

## Installation

### Automatic (recommended)

1. Run `composer create-project joomlatools/platform`
2. Complete the steps
3. Access Joomla administrator at `http://example.com/web/administrator`

### Manual

1. Clone the git repo - `git clone https://github.com/joomlatools/joomlatools-platform.git`
2. Run `composer install`
3. Create a new database and import the MySQL data in the following order:
   * `install/mysql/schema.sql`
   * `install/mysql/data.sql`
   * `install/mysql/legacy.sql`
4. Copy `.env.example` to `.env` and update environment variables:
   * `JOOMLA_DB_NAME` - Database name
   * `JOOMLA_DB_USER` - Database user
   * `JOOMLA_DB_PASS` - Database password
   * `JOOMLA_DB_HOST` - Database host
   * `JOOMLA_ENV` - Set to environment (`development`, `staging`, `production`)
   * `JOOMLA_KEY` - A 32 character random string
   * `JOOMLA_CACHE` - [OPTIONAL] True or false to enable or disable caching
   * `JOOMLA_DEBUG` - [OPTIONAL] True or false to enable or disable debug mode
5. Access Joomla administrator at `http://example.com/web/administrator` and login with both username and password `admin`.

### Joomlatools Console

Our [Joomlatools Console] also supports the Joomlatools Platform. To install the platform with a single command, add the `--repo=platform` flag:

joomla site:create joomlatools-platform --repo=platform

## Configuration

To be able to access your Joomla site at `http://example.com/`set your site vhost document root
to `/path/to/site/web/`.

If you are using shared hosting and/or you are not allowed to change your server Apache vhost
configuration directly rename [htaccess.txt](htaccess.txt) to .htaccess and modify it use your
domain name to set web root or document root to /web.

## Deploys

There is currently one method to deploy platform sites out of the box:

* [joomlatools-console-capistrano](https://github.com/joomlatools/joomlatools-console-capistrano)

Any other deployment method can be used as well with one requirement:

`composer install` must be run as part of the deploy process.

## Documentation

* [Directory structure](https://www.joomlatools.com/developer/platform/directory-structure/)
* [Configuration files](https://www.joomlatools.com/developer/platform/configuration-files/)
* [Environment variables](https://www.joomlatools.com/developer/platform/environment-variables/)
* [Composer](https://www.joomlatools.com/developer/platform/composer/)
* [Deployment](https://www.joomlatools.com/developer/platform/deployment/)

## Contributing

Joomlatools Platform is an open source, community-driven project. Contributions are welcome from everyone.
We have [contributing guidelines](CONTRIBUTING.md) to help you get started.

## Contributors

See the list of [contributors](https://github.com/joomlatools/joomlatools-platform/contributors).

## License

Joomlatools Platform is free and open-source software licensed under the [GPLv3 license](LICENSE.txt).

## Community

Keep track of development and community news.

* Follow [@joomlatoolsdev on Twitter](https://twitter.com/joomlatoolsdev)
* Join [joomlatools/dev on Gitter](http://gitter.im/joomlatools/dev)
* Read the [Joomlatools Developer Blog](https://www.joomlatools.com/developer/blog/)
* Subscribe to the [Joomlatools Developer Newsletter](https://www.joomlatools.com/developer/newsletter/)

[Joomlatools Platform]: http://www.joomlatools.com/developer/platform/
[Joomlatools Console]: http://www.joomlatools.com/developer/tools/console/

joomlatools-platform

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README