Home

Welcome to the Materia Wiki!

Important note: the majority of Materia's documentation is provided on our dedicated docs site. The contents of this wiki are intended to supplement the docs site and include helpful tips, troubleshooting, and resources for new-to-Materia developers and contributors.

The instructions in this wiki are applicable to Materia version 10 and later.

First time setup

1. Clone Materia locally (if you plan on making code changes, you should create a fork and clone it instead of cloning the ucfopen repo.)
2. Ensure you have docker installed locally.
3. cd docker in the Materia repo directory, followed by ./run_first.sh
4. Run docker-compose up. This process must be kept running when working on your local dev instance.
5. In a second terminal window or tab, navigate to the Materia repo directory and run yarn install && yarn dev
6. Visit 127.0.0.1

Common issues troubleshooting

Visit the common issues for new developers page.

Creating a local user

In Materia/docker, run the following:

$ ./run.sh php oil r admin:new_user <username> <first> <mi> <last> <email> <password>

Assigning user roles

In Materia/docker, run the following:

$ ./run.sh php oil r admin:give_user_role <username> <role>

Valid roles are basic_author, support_user, and super_user.