This repo is a starter-based Redis app for JS and Node using:

• Redis Cloud
• Express
• A feature-flag and remote-config API backed by Redis

Requirements

• bun
• docker
  • Optional

Getting started

Copy and edit the .env file:

cp .env.example .env

Your .env file should contain the connection string you copied from Redis Cloud.

Your .env.docker file will look similar to .env, but should use the appropriate docker internal URLs. Here is an example:

REDIS_URL="redis://redis:6379"

Next, spin up docker containers:

bun docker

You should have a server running on http://localhost:<port> where the port is set in your .env file (default is 8080). You can test the following routes:

1. GET /api/admin/flags - List all flag definitions
2. PUT /api/admin/flags/:flagKey - Create or update a flag definition
3. DELETE /api/admin/flags/:flagKey - Delete a flag definition
4. GET /api/flags/:flagKey - Read a flag definition
5. GET /api/flags/:flagKey/evaluate?[environment=<env>]&[subject=<userId>]&[region=<region>] - Evaluate a flag for a subject

Running tests

There are some tests in the __tests__ folder that can be run with the following command:

bun test

These tests set up and tear down on their own. You can modify them if you want to leave data in Redis.

Running locally outside docker

To run the development server outside of docker:

bun install
# then
bun dev

Other Scripts

Formatting code:

bun format

Updating dependencies:

bun update

Connecting to Redis Cloud

If you don't yet have a database setup in Redis Cloud get started here for free.

To connect to a Redis Cloud database, log into the console and find the following:

1. The public endpoint (looks like redis-#####.c###.us-east-1-#.ec2.redns.redis-cloud.com:#####)
2. Your username (default is the default username, otherwise find the one you setup)
3. Your password (either setup through Data Access Control, or available in the Security section of the database page.

Combine the above values into a connection string and put it in your .env and .env.docker accordingly. It should look something like the following:

REDIS_URL="redis://default:<password>@redis-#####.c###.us-west-2-#.ec2.redns.redis-cloud.com:#####"

Run the tests to verify that you are connected properly.

Learn more

To learn more about Redis, take a look at the following resources:

• Redis Documentation - learn about Redis products, features, and commands.
• Learn Redis - read tutorials, quick starts, and how-to guides for Redis.
• Redis Demo Center - watch short, technical videos about Redis products and features.