From 89642e45e2a1633204db9c35151a657f2ca63d38 Mon Sep 17 00:00:00 2001
From: Elia Bieri <elia.bieri@iterativ.ch>
Date: Thu, 16 Feb 2023 13:46:02 +0100
Subject: [PATCH] Add currents.dev documentation

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/README.md b/README.md
index 71693b77..d78401a3 100644
--- a/README.md
+++ b/README.md
@@ -131,3 +131,24 @@ Preferences -> Tools -> Actions on Save
 ![](docs/envfile_plugin_settings.png)
 
 #### Install the tailwind css Plugin from Jetbrains
+
+## currents.dev
+
+This project uses [currents.dev](https://currents.dev) to run the Cypress tests concurrently.  
+The following steps were taken to set it up:
+
+- Create a new project on currents.dev
+- Add the generated `projectId` to the cypress configuration file
+- Install `@currents/cli` as a dev dependency
+- Add the following script to the `package.json` file:
+  ```json
+  "cypress:ci": "currents run --parallel --record --key $CURRENTS_KEY",
+  ```
+- Create a new Bitbucket pipelines job that exports the `CURRENTS_KEY` and runs the `cypress:ci` script
+- Refactor the pipeline steps so that the dependencies are installed first and then the other steps are run in
+  parallel.  
+  You can then run multiple instances of the previously created job in parallel.  
+  See `.bitbucket-pipelines.yml` for an example.
+
+> 💡 The number of cypress worker jobs depends on the number of cypress tests.
+> Too many workers for too few tests will result in a lot of idle workers.