A reference implementation for using Ashlar to build flexible-schema web applications.

• Docker >= 1.13.0 (must be compatible with Compose file v3 syntax)
• docker-compose >= 1.10.0 (must be compatible with Compose file v3 syntax)

Copy an environment file for the Ashlar instance and the frontend (you can change some variables if you know they won't suit your setup, but the example file should work fine for local development):

cp ./ashlar/.env.example ./ashlar/.env
cp ./frontend/.env.example ./frontend/.env

Run the update script to make sure your containers are up to date:

./scripts/update

This script will also load some sample data into Ashlar that you can play around with.

Run development servers with the server script:

./scripts/server

The Ashlar instance will be accessible on localhost:8000, the schema editor will be accessible on localhost:9000, and the frontend for the app will be accessible on localhost:4567. All three should reload in realtime as you edit files.

You can choose to run only the services you need by passing the server script an optional argument:

# Run only the Ashlar instance
./scripts/server ashlar

# Run only the schema editor
./scripts/server editor

# Run only the frontend
./scripts/server frontend

You can also run custom commands in the containers using the server script:

# Run a custom command in the Ashlar instance (python entrypoint)
./scripts/server ashlar manage.py runserver

# Run a custom command in the schema editor (grunt entrypoint)
./scripts/server editor watch

Note that the initial migrations for the Ashlar server automatically create an admin user with the username admin and the password admin. You can use these credentials to log into the schema editor and the API admin portal.