You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -94,14 +94,16 @@ All methods take an `Id`, which should be of type `number | string`. Commonly, t
94
94
95
95
Install dependencies with `yarn`.
96
96
97
-
To run tests, you will need to have a Redis server running. You can do this by installing Redis, and running `redis-server`. Alternatively, you can run the CI build, which includes tests, by installing [act](https://github.com/nektos/act). This requires Docker to be running - on MacOS that means running `Docker.app` from your `Applications` folder.
97
+
To run tests, you will need to have a Redis server running. There are a few methods to do this:
98
98
99
-
### Testing
99
+
- Install Redis (using something like homebrew), and then run `redis-server`.
100
+
- Run Redis from Docker: `docker run -it -p 6379:6379 -d --name=redis --restart=always redis:alpine`
101
+
- Run the CI build, which includes tests, by installing [act](https://github.com/nektos/act). This requires Docker to be running - on MacOS that means running `Docker.app` from your `Applications` folder.
100
102
101
-
Before running tests, make sure you have redis running. You can start redis in Docker, for example, by executing `docker run -it -p 6379:6379 -d --name=redis --restart=always redis:alpine`
103
+
### Testing
102
104
103
-
*`yarn ci`: Runs the CI build, including linting, type checking, and tests. Requires [act](https://github.com/nektos/act) to run GitHub actions locally.
104
-
*`yarn lint`: Runs ESLint.
105
-
*`yarn test`: Runs Jest.
106
-
*`yarn typecheck`: Runs TypeScript, without emitting output.
107
-
*`yarn build`: Runs TypeScript and outputs to `./lib`.
105
+
-`yarn ci`: Runs the CI build, including linting, type checking, and tests. Requires [act](https://github.com/nektos/act) to run GitHub actions locally.
106
+
-`yarn lint`: Runs ESLint.
107
+
-`yarn test`: Runs Jest.
108
+
-`yarn typecheck`: Runs TypeScript, without emitting output.
109
+
-`yarn build`: Runs TypeScript and outputs to `./lib`.
0 commit comments