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
+31-11Lines changed: 31 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,9 +13,8 @@ Solutions to the course programming challenges can be found on the `solutions` b
13
13
In order to start and run this application, you will need:
14
14
15
15
-[Node.js](https://nodejs.org/en/download/) (8.9.4 or newer, we recommend using the current Long Term Stable version)
16
-
- npm (installed with Node.js)
17
-
- Access to a local or remote installation of [Redis](https://redis.io/download) version 5 or newer (local preferred)
18
-
- If you want to try the RedisTimeSeries exercises, you'll need to make sure that your Redis installation also has the [RedisTimeSeries Module](https://oss.redis.com/redistimeseries/) installed
16
+
- npm (installed with Node.js).
17
+
- Access to a local or remote installation of [Redis Stack](https://redis.io/docs/stack/get-started/install/) - local preferred, we provide a Docker Compose file in this repo, read on for details.
19
18
20
19
If you're using Windows, check out the following resources for help with running Redis:
21
20
@@ -24,26 +23,39 @@ If you're using Windows, check out the following resources for help with running
You'll also need to have the RedisTimeSeries module installed, which you can get by going through the following steps:
38
+
39
+
You'll also need to have a Redis Stack instance running. Either [install it locally](https://redis.io/docs/stack/get-started/install/), or use the Docker Compose file provided:
40
+
33
41
- Install [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/).
34
-
- Check your Docker Compose version using ```docker-compose --version```. In order for our compose file to work, you need to have at least v1.27.0.
35
42
- Start up the Docker daemon.
36
-
- Run ```docker-compose up -d``` in the project directory. This command will give you Redis on localhost port 6379 with no password required, with the required RedisTimeSeries module installed. The container will persist Redis data to the ```redisdata``` folder.
43
+
- Run ```docker-compose up -d``` in the project directory. This command will give you Redis Stack on localhost port 6379 with no password required. The container will persist Redis data to the ```redisdata``` folder.
37
44
38
45
You should see the following once the command has successfully run:
Creating network "ru102js_default" with the default driver
49
+
Creating redis_ru102js ... done
50
+
```
41
51
42
-
You'll also see the ```ru102js``` container running if you open up the Docker app.
52
+
You'll also see the ```redis_ru102js``` container running if you open up the Docker app.
43
53
44
-
If you get an error that says something like ```Version in "./docker-compose.yml" is unsupported```, you probably need to update your docker compose version to 1.27.0 or higher.
54
+
If you want to shut down the Redis Stack container, use:
45
55
46
-
If you want to shut down the Redis container, you can run ```docker-compose down```.
56
+
```
57
+
docker-compose down
58
+
```
47
59
48
60
# Configuration
49
61
@@ -134,6 +146,14 @@ subsets of tests and many more options:
134
146
npm testdev
135
147
```
136
148
149
+
# Optional (but Recommended): RedisInsight
150
+
151
+
RedisInsight is a graphical tool for viewing data in Redis and managing Redis server instances. You don't need to install it to be successful with this course, but we recommend it as a good way of viewing data stored in Redis.
152
+
153
+
To use RedisInsight, you'll need to [download it](https://redis.io/docs/ui/insight/) then point it at your Redis instance.
154
+
155
+
If you're using the Docker Compose file provided with this course to run Redis Stack, you can optionally choose to access a web-based version of Redis Stack at `http://localhost:8001` whenever the container is running.
156
+
137
157
# Linting
138
158
139
159
This project uses [ESLint](https://eslint.org/) with a slightly modified version of the
0 commit comments