Home

Pre-requisites for running bc-local

export BRITECORE_CODE_DIR=<path/to/britecore/code/dir>
mkdir -p ~/bc-local-data-load
export BRITECORE_DATA_LOAD_DIR=~/bc-local-data-load
export KIND_EXPERIMENTAL_PROVIDER=podman
export AWS_PROFILE=<profile_name> && aws sso login --profile <profile_name>  # Replace <profile_name> with a profile from ~/.aws/config

Add the export statements to the bottom of your ~/.zshrc if you'd like these to be initialized in any new terminal session

How do I install?

Note: Since this is a homebrew cask there is no need to clone this repository. You just need to have homebrew installed!

brew tap intuitivewebsolutions/bc-local
brew install bc-local

How do I run BriteCore?

Warning

Make sure that your Podman setup has enough resources allocated (≥ 8GB memory) to it in order to run a BriteCore site. You can use the following command to automatically use recommended settings podman machine init podman-machine-default --cpus 8 --memory 8192 --disk-size 100 --now.

This will launch a local britecore site from scratch:

bc-local bootstrap client=rowanmutual celery=false pytest=false #change args as needed
bc-local status
bc-local open web

The site is available once the web pod (seen using bc-local status) is Running all containers.