This app demonstrates authentication token storage with Redis, a well-known Redis use case. The app stores auth tokens in Redis with automatic expiry (TTL) and includes a protected Todo CRUD API that requires a valid token to access.

Built with:

• Redis Cloud
• Express
• Bun

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.

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).

Auth routes

1. POST /api/auth/register - Register with { "username": "...", "password": "..." }
2. POST /api/auth/login - Login and receive a token
3. POST /api/auth/logout - Logout (requires Authorization: Bearer <token>)
4. POST /api/auth/refresh - Refresh token (requires Authorization: Bearer <token>)
5. GET /api/auth/me - Get current user info (requires Authorization: Bearer <token>)

Todo routes (all require Authorization: Bearer <token>)

1. GET /api/todos - Gets all todos
2. GET /api/todos/:id - Gets a todo by ID
3. GET /api/todos/search?[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

Running tests

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

bun test

These tests setup and teardown 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. 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.