Comment on page

Contributing

We're open source! Get started hacking on CBElasticsearch to add a new feature, fix the docs, or prove a regression.

Follow these steps to get started hacking on CBElasticsearch:
1.Clone the module - git clone [email protected]:coldbox-modules/cbox-elasticsearch.git
2.Install dependencies - box install
3.Start a new Elasticsearch instance​
4.Start the cbelasticsearch server - box start
5.Run tests - box testbox run
Running Elasticsearch
To run the test suite you need a running instance of ElasticSearch. We have provided a docker-compose.yml file in the root of the repo to make this easy as possible. Run docker-compose up --build ( omit the --build after the first startup ) in the root of the project and open http://localhost:8080/tests/runner.cfm to run the tests.
If you would prefer to set up Elasticsearch yourself, make sure you start this app with the correct environment variables set:
ELASTICSEARCH_PROTOCOL=http
ELASTICSEARCH_HOST=127.0.0.1
ELASTICSEARCH_PORT=9200

Tasks

Last modified 11mo ago