Installation
In order to install Codice you will need:
- PHP 5.6.4+
- OpenSSL PHP Extension
- PDO PHP Extension
- Mbstring PHP Extension
- Tokenizer PHP Extension
- MySQL with InnoDB support
This document outlines all possible ways to get working installation of Codice.
If you are looking for a regular and recommended way, consult previous chapter.
Getting into details, there is a couple of paths to complete each step. Read all sections below and choose the one making most sense for your use case.
Getting the files
You have few options, depending on your needs and purpose of the installation.
- prebuilt package — already includes third party PHP dependencies and built assets; their source files as well as any frontend dependencies and dev files are stripped
- clone the repository — contains source files for the frontend assets and Git repository data and it's obvious choice when developing; third party code must be obtained using respective dependency managers
- GitHub snapshot — as above, requires you to get dependencies and compile assets on your own, but it's not a Git repository
Getting third party dependencies
This section does not apply to prebuilt package. In any other case you need to run Composer and Yarn dependency managers.
Compiling assets
This section does not apply to prebuilt package. Otherwise you need to run
gulp assets
(or node_modules/.bin/gulp assets
if you don't have global
installation).
Database setup
- the easiest way is to visit
yourdomain.com/codice/install
and follow the instructions - alternatively, you can either run
php artisan codice:install --email=john.doe@example.com --password=secret
to set up everything without even leaving the CLI or just callphp artisan codice:install
to run interactive CLI wizard - it is also possible to just perform each step manually:
- copy
.env.example
to.env
and fill it with all required informations - run the migrations using
php artisan migrate
- manually create new record for your user (hashing the password using Laravel's
bcrypt()
helper)
- copy
For development, you may be also interested in running
php artisan ide-helper:generate
to make your IDE slightly less confused about all that Laravel magic.