As cortex itself is only a Rails Engine, it needs to be mounted within a parent Rails applicaton. cortex-starter serves as a starting point for new users, with cortex and cortex-plugins-core already mounted and configured with several example ContentTypes/Decorators. Start by cloning the repository:
Copy and rename the example .env.example file as .env and modify it to match your environment.
For a rudimentary setup, these variables should be configured:
Execute $ bin/rails secret twice to generate both an APP_SECRET and DEVISE_SECRET
If the superuser isn't used for the app databases, the DATABASE_USERNAME and DATABASE_PASSWORD should be set accordingly.
Dependencies
System
macOS
Install the Xcode Command Line tools:
1
$ xcode-select --install
Copied!
Install all Cortex system-wide dependencies (and the readline Ruby/byebug build dependency) using Homebrew from the Brewfile via $ brew install $(cat Brewfile|grep -v "#")
Install all Cortex system-wide dependencies (and the readline Ruby/byebug build dependency) using your distribution's package manager (pacman, apt-get, yum, etc). For example, with Ubuntu's apt-get:
Ubuntu and Redhat/Fedora do not have an official elasticsearch package - you must use Elasticsearch's repositories for APT or RPM or follow these manual instructions. The same goes for phantomjs. Build from source or use a PPA. Additionally, yarn will need its repository added for these distributions. Follow these instructions. Other Linux distributions likely have these as prebuilt packages in their official or user repositories.
cortex-starter ships with an automated setup script. Execute this in lieu of the Manual Setup steps below, if you're comfortable doing so:
1
$ bin/setup
Copied!
Manual
Create databases:
1
$ bin/rails db:create
Copied!
Initialize the schema:
1
$ bin/rails db:schema:load
Copied!
Seed database with a top-level tenant, the superuser and Custom Content data, then rebuild the Elasticsearch index:
1
$ bin/rails db:seed
2
$ bin/rails cortex_starter:content_types:seed
3
$ bin/rails cortex:rebuild_indexes
Copied!
Server
Start Cortex, Sidekiq and live Webpack rebuild via Foreman with the dev-server script:
1
$ bin/dev-server
Copied!
The admin interface should now be accessible locally at http://localhost:3000. To access Cortex as superadmin, login as [email protected] with password welcome1.