development.md

Developer's guide

To run a local copy of Capella you'll need:

• Docker and docker-compose
• Node.js and npm/Yarn

Setting up the environment

Follow the deployment guide to run a local copy of Capella.

Build scripts and styles

Use webpack to build scripts and styles for Capella. Firstly you heed to install Node.js dependencies.

npm i

or

yarn install

Build bundles for development (fast rebuild). Run this command in separate terminal. Webpack will watch project files and rebuild bundles on changes.

npm run build:dev

or

yarn build:dev

Build bundles for production (compress bundles). Run this command before committing changes.

npm run build

or

yarn build

Fix PHP code style

Run this command before committing changes.

docker exec -i capella_php_1 composer csfix

Watch server's logs

If you need to watch Capella server's logs then connect to nginx container and open /var/log/nginx/capella_error.log

You can watch the end of logs file with the following command:

docker exec -i capella_nginx_1 tail -f /var/log/nginx/capella_error.log

Disable cache

If you need to disable cache then set param DISABLE_CACHE in .env file to True

...
### Cache server connection params
CACHE_HOST = memcached
CACHE_PORT = 11211
DISABLE_CACHE = True