Skip to content

Commit f497c36

Browse files
committed
update README
1 parent e605170 commit f497c36

File tree

3 files changed

+24
-9
lines changed

3 files changed

+24
-9
lines changed

ad-server-cache-bun/README.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,30 @@
1-
# Elysia with Bun runtime
1+
# Example: Ad Server using Bun, ElysiaJS, and Dragonfly
2+
3+
## Packages Used
4+
5+
- [ElysiaJS](https://elysiajs.com/) is a TypeScript framework supercharged by the [Bun](https://bun.sh/) runtime with end-to-end type safety.
6+
- [ioredis](https://github.com/redis/ioredis) is a Redis client for Node.js that can be used to interact with Dragonfly.
7+
- [typebox](https://github.com/sinclairzx81/typebox) is a JSON schema type builder and validator with static type resolution for TypeScript.
8+
9+
## Local Setup
10+
11+
- Make sure that you have [Bun v1.0.6+](https://bun.sh/) installed locally.
12+
- Make sure that you have [Docker](https://docs.docker.com/engine/install/) installed locally.
13+
14+
## Run Dragonfly & Service Application
15+
16+
- Run a Dragonfly instance using Docker:
217

3-
## Getting Started
4-
To get started with this template, simply paste this command into your terminal:
518
```bash
6-
bun create elysia ./elysia-example
19+
docker run -p 6379:6379 --ulimit memlock=-1 docker.dragonflydb.io/dragonflydb/dragonfly
720
```
821

9-
## Development
10-
To start the development server run:
22+
- Install dependencies and run the service application:
23+
1124
```bash
12-
bun run dev
25+
# within the root directory of this example (dragonfly-examples/ad-server-cache-bun)
26+
bun install
27+
bun run dev # (or `bun dev`)
1328
```
1429

15-
Open http://localhost:3000/ with your browser to see the result.
30+
- The ad server API would be running on `http://localhost:3000/`

ad-server-cache-bun/bun.lockb

0 Bytes
Binary file not shown.

ad-server-cache-bun/src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,5 +37,5 @@ const app = new Elysia()
3737
.listen(3000);
3838

3939
console.log(
40-
`🦊 Elysia is running at ${app.server?.hostname}:${app.server?.port}`
40+
`Ad server API is running at ${app.server?.hostname}:${app.server?.port}`
4141
);

0 commit comments

Comments
 (0)