Pull down this project locally.
when you enter the directory if you have direnv installed run:
direnv allowIf you do not run
nix develop --impurethis will pull down all dependencies, install hooks and formatters etc.
For those who prefer Docker, we've included a docker-compose.yml file to quickly set up a development environment with all required services.
-
Make sure you have Docker and Docker Compose installed on your system.
-
Start the development environment:
docker-compose up -dThis will start:
- Elasticsearch (accessible at http://localhost:9200)
- Kibana (accessible at http://localhost:5601)
- Redis (accessible at localhost:6379)
All services include health checks to ensure they're properly initialized before use.
- To stop the environment:
docker-compose down- To view logs from the services:
docker-compose logs -fDuring development with the Nix setup, you will need to start a local elasticsearch instance. To start elasticsearch run:
just upThis will start process-compose and an elastic search instance.
You can now open a new terminal window and run tests using pest. For conviance purposes the nix shell has the command p linked to run ./vendor/bin/pest and pf linked to run ./vendor/bin/pest --filter "$@".
When using the Docker setup, all required services are already running after executing docker-compose up -d. You can run tests directly against these services.
To run tests:
./vendor/bin/pestTo run a specific test:
./vendor/bin/pest --filter="test_name"The Docker environment provides all necessary services configured with appropriate default settings for development and testing.