diff --git a/acceptance/repository-cloudant/README.md b/acceptance/repository-cloudant/README.md new file mode 100644 index 000000000000..8c96859601ee --- /dev/null +++ b/acceptance/repository-cloudant/README.md @@ -0,0 +1,67 @@ +# @loopback/test-repository-cloudant + +Acceptance tests for `@loopback/repository` + `loopback-connector-cloudant`. + +## Running the test suite + +### Using own Cloudant instance + +If you have a local Cloudant instance listening on `localhost` and the default +port, with a `root` user and an empty password, use the following command: + +```bash +npm test +``` + +If you have a local or remote Cloudant instance and would like to use that to +run the test suite, use the following command: + +**Linux & MacOS** + +```bash +CLOUDANT_URL= CLOUDANT_HOST= CLOUDANT_PORT= CLOUDANT_USER= CLOUDANT_PASSWORD= CLOUDANT_DATABASE= npm test +``` + +**Windows** + +```bash +CLOUDANT_URL= +SET CLOUDANT_HOST= +SET CLOUDANT_PORT= +SET CLOUDANT_USER= +SET CLOUDANT_PASSWORD= +SET CLOUDANT_DATABASE= +npm test +``` + +### Using Docker (Linux, MacOS, WSL) + +If you do not have a local Cloudant instance, you can also run the test suite +with very minimal requirements. + +- Assuming you have [Docker](https://docs.docker.com/engine/installation/) + installed, run the following script which would spawn a Cloudant instance on + your local: + + ```bash + source setup.sh + ``` + + Where ``, ``, ``, ``, `` and `` are + optional parameters. The default values are `url`, `localhost`, `3306`, + `root`, `pass` and `testdb` respectively. + +- Run the test: + + ```bash + npm test + ``` + +## Contributors + +See +[all contributors](https://github.com/strongloop/loopback-next/graphs/contributors). + +## License + +MIT