Repository files navigation

This is aRedis starter template for JS andNode using:

• Redis Cloud
• Express

• bun
• docker
  • Optional

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 isan example:

REDIS_URL="redis://redis:6379"

Next, spin up docker containers:

bun docker

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

1. GET /api/todos - Gets all todos
2. GET /api/todos/:id - Gets a todo by ID
3. GET /api/todos?[name=<name>]&[status=<status>] - Search for todos by name and/or status
4. POST /api/todos - Create a todo with{ "name": "Sample todo" }
5. PATCH /api/todos/:id - Update todo by ID with{ "status": "todo|in progress|complete" }
6. DELETE /api/todos/:id - Delete a todo by ID

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

buntest

These tests setup and teardown on their own. You can modify them if you want to leave data in Redis.

To run the development server outside of docker:

bun install# thenbun dev

Formatting code:

bun format

Updating dependencies:

bun update

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

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

1. Thepublic endpoint (looks likeredis-#####.c###.us-east-1-#.ec2.redns.redis-cloud.com:#####)
2. Yourusername (default is the default username, otherwise find the one you setup)
3. Yourpassword (either setup through Data Access Control, or available in theSecurity section of the databasepage.

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

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

Run thetests to verify that you are connected properly.

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.