feat: Add a tutorial example for URL Shortner built using DiceDB and Go #1259

Prachi-Jamdade · 2024-11-09T14:00:51Z

This commit adds an example of how to integrate the DiceDB Go SDK for building a URL shortener application.

The tutorial walks through setting up a basic URL shortening service, providing -

Instructions on creating short URLs
Redirecting to the original URLs
Storing data in DiceDB.

The application utilizes the Set and Get commands from DiceDB to store and retrieve shortened URLs, and the example is designed to help developers quickly understand and implement a URL shortener using DiceDB and Go.

JyotinderSingh

Thanks for contributing a tutorial for dicedb. It's a great way to help new users get started.

I have left some comments on this PR, please address them.

docs/src/content/docs/get-started/url-shortner.mdx

Prachi-Jamdade · 2024-11-09T17:48:20Z

Hi @JyotinderSingh, I have addressed above mentioned review changes and pushed the code.

Please take a look at it.

everlearner

Minor comments in the shortener code.

everlearner · 2024-11-11T02:30:22Z

examples/url-shotener/main.go

nit: typo in directory name url-shortner

everlearner · 2024-11-11T02:30:26Z

examples/url-shotener/main.go

+// Initialize DiceDB connection
+func init() {
+	db = dicedb.NewClient(&dicedb.Options{
+		Addr: "localhost:7379",


Get hostname and port from ENV variables?
Similar to:

dice/examples/leaderboard-go/main.go

Lines 36 to 44 in 44779c2

dhost := "localhost"

if val := os.Getenv("DICEDB_HOST"); val != "" {

dhost = val

}

dport := "7379"

if val := os.Getenv("DICEDB_PORT"); val != "" {

dport = val

}

everlearner · 2024-11-11T02:30:29Z

examples/url-shotener/main.go

+}
+
+// Creates a short URL from a given long URL
+func CreateShortURL(c *gin.Context) {


nit:

Suggested change

func CreateShortURL(c *gin.Context) {

func createShortURL(c *gin.Context) {

everlearner · 2024-11-11T02:30:31Z

examples/url-shotener/main.go

+}
+
+// Redirects to the original URL based on the short URL ID
+func RedirectURL(c *gin.Context) {


nit:

Suggested change

func RedirectURL(c *gin.Context) {

func redirectURL(c *gin.Context) {

everlearner · 2024-11-11T02:53:06Z

examples/url-shotener/main.go

+	requestBody.ID = shortID
+	requestBody.ShortURL = "http://localhost:8080/" + shortID


Do we need to store ID and ShortURL in the struct?
Having just LongURL is sufficient?

The mapping b/w ID and LongURL is anyway stored in the DiceDB.

JyotinderSingh · 2024-11-13T15:57:11Z

Thanks for addressing the comments @Prachi-Jamdade. Could you please resolve comments by @everlearner as well?

…ke functions unexported

Prachi-Jamdade · 2024-11-14T17:11:51Z

Hey @JyotinderSingh, pushed the code addressing changes raised by @everlearner

everlearner

Thanks for making the changes.

Prachi-Jamdade · 2024-11-16T14:09:34Z

Hey @JyotinderSingh, any update ?

JyotinderSingh · 2024-11-19T14:24:31Z

Hey @JyotinderSingh, any update ?

Will review soon

JyotinderSingh

Thanks for addressing the reviews so far @Prachi-Jamdade. Documentation is a critical aspect of any project, and needs to be extremely polished. Keeping that in mind I've suggested some improvements.

JyotinderSingh · 2024-11-20T16:15:59Z

docs/src/content/docs/tutorials/url-shortener.md

+1. Go installed (at least version 1.18)
+2. DiceDB server running locally


Suggested change

1. Go installed (at least version 1.18)

2. DiceDB server running locally

1. Go (version 1.18 or later): [Download Go](https://golang.org/dl/)

2. DiceDB: A DiceDB server running locally. Refer to the [DiceDB Installation Guide](https://github.com/DiceDB/dice/pull/1259/get-started/installation) if you haven't set it up yet.

JyotinderSingh · 2024-11-20T16:19:38Z

docs/src/content/docs/tutorials/url-shortener.md

+## DiceDB Commands Used
+
+Here are the main DiceDB commands we’ll use to store and retrieve URLs.
+
+1. `Set` Command: Stores a key-value pair in DiceDB.
+Syntax - `Set(key, value, expiration)`
+`key`: Unique identifier (e.g., short URL code)
+`value`: The data to store (serialized JSON)
+`expiration`: Optional; 0 means no expiration
+
+2. `Get` Command: Retrieves the value associated with a key.
+Syntax - `Get(key)`
+`key`: The identifier for the data to retrieve.


Suggested change

## DiceDB Commands Used

Here are the main DiceDB commands we’ll use to store and retrieve URLs.

1. `Set` Command: Stores a key-value pair in DiceDB.

Syntax - `Set(key, value, expiration)`

`key`: Unique identifier (e.g., short URL code)

`value`: The data to store (serialized JSON)

`expiration`: Optional; 0 means no expiration

2. `Get` Command: Retrieves the value associated with a key.

Syntax - `Get(key)`

`key`: The identifier for the data to retrieve.

## Understanding DiceDB Commands

We'll use the following DiceDB commands:

### `SET` Command

Stores a key-value pair in DiceDB.

- **Syntax**: `SET key value [expiration]`

- `key`: Unique identifier (e.g., short URL code)

- `value`: Data to store (e.g., serialized JSON)

- `expiration`: Optional; time-to-live in seconds (use `0` for no expiration)

### `GET` Command

Retrieves the value associated with a key.

- **Syntax**: `GET key`

- `key`: Identifier for the data to retrieve

JyotinderSingh · 2024-11-20T16:19:59Z

docs/src/content/docs/tutorials/url-shortener.md

+Syntax - `Get(key)`
+`key`: The identifier for the data to retrieve.
+
+## Code overview


Suggested change

## Code overview

## Writing the Code

Create a file named `main.go` and add the following code:

JyotinderSingh · 2024-11-20T16:21:29Z

docs/src/content/docs/tutorials/url-shortener.md

+    }
+    ```
+
+## Explanation of Key Parts


Suggested change

## Explanation of Key Parts

## Explanation

JyotinderSingh · 2024-11-20T16:24:43Z

docs/src/content/docs/tutorials/url-shortener.md

+1. Database Initialization: The `init()` function sets up a DiceDB client to connect to `localhost:7379`.
+2. `CreateShortURL` Endpoint: Handles the `/shorten` route. It generates a unique ID, constructs the short URL, serializes the URL data, and saves it in DiceDB.
+3. `RedirectURL` Endpoint: Handles the `/:id` route. It retrieves the original URL by the short ID from DiceDB and redirects the user to it.
+4. Starting the Server: The `main` function starts the Gin server on port `8080`.


We should make use of subheadings to make this clearer. PTAL at the following approach to write this:

Suggested change

1. Database Initialization: The `init()` function sets up a DiceDB client to connect to `localhost:7379`.

2. `CreateShortURL` Endpoint: Handles the `/shorten` route. It generates a unique ID, constructs the short URL, serializes the URL data, and saves it in DiceDB.

3. `RedirectURL` Endpoint: Handles the `/:id` route. It retrieves the original URL by the short ID from DiceDB and redirects the user to it.

4. Starting the Server: The `main` function starts the Gin server on port `8080`.

### 1. Initialize the DiceDB Client

We set up the DiceDB client in the `init` function:

```go

db = dicedb.NewClient(&dicedb.Options{

Addr: "localhost:7379",

})

```

### 2. Create Short URL Endpoint

- **Input Validation**: Ensures the `long_url` field is present.

- **Short ID Generation**: Uses `uuid` to create a unique 8-character ID.

- **Data Serialization**: Converts the `URL` struct to JSON.

- **Data Storage**: Saves the JSON data in DiceDB with the `Set` command.

- **Response**: Returns the generated short URL.

### 3. Redirect to Original URL Endpoint

- **Data Retrieval**: Fetches the URL data from DiceDB using the `Get` command.

- **Data Deserialization**: Converts JSON back to the `URL` struct.

- **Redirection**: Redirects the user to the `LongURL`.

### 4. Start the Server

The `main` function sets up the routes and starts the server on port `8080`.

JyotinderSingh · 2024-11-20T16:27:18Z

docs/src/content/docs/tutorials/url-shortener.md

+## Interacting with the application
+
+1. Start DiceDB: Ensure DiceDB is running.
+2. Test the API:


Suggested change

2. Test the API:

## Testing the Application

JyotinderSingh · 2024-11-20T16:28:56Z

docs/src/content/docs/tutorials/url-shortener.md

+        Send a POST request to `/shorten` with JSON body on Postman:
+        ```
+        {
+            "long_url": "https://example.com"
+        }
+        ```
+
+        OR
+
+        ```curl
+        curl -X POST -H "Content-Type: application/json" -d '{"long_url": "https://example.com"}' http://localhost:8080/shorten
+        ```


Suggested change

Send a POST request to `/shorten` with JSON body on Postman:

```

{

"long_url": "https://example.com"

}

```

OR

```curl

curl -X POST -H "Content-Type: application/json" -d '{"long_url": "https://example.com"}' http://localhost:8080/shorten

```

**Using `curl`:**

```bash

curl -X POST -H "Content-Type: application/json" -d '{"long_url": "https://example.com"}' http://localhost:8080/shorten

```

**Response:**

```json

{

"short_url": "http://localhost:8080/<short ID generated by the server>"

}

```

JyotinderSingh · 2024-11-20T16:30:33Z

docs/src/content/docs/tutorials/url-shortener.md

+        Send a GET request to `/:id` with the short URL ID on Postman
+
+        OR
+
+        ```curl
+        curl -L http://localhost:8080/{short_id}
+        ```


Suggested change

Send a GET request to `/:id` with the short URL ID on Postman

OR

```curl

curl -L http://localhost:8080/{short_id}

```

**Using `curl`:**

```bash

curl -L http://localhost:8080/abcd1234

```

**Using a Browser:**

Navigate to:

```

http://localhost:8080/abcd1234

```

You should be redirected to `https://example.com`.

JyotinderSingh · 2024-11-20T16:30:54Z

examples/url-shortener/.dockerignore

This file is not needed.

JyotinderSingh · 2024-11-20T16:34:25Z

examples/url-shortener/Dockerfile

We don't need such a detailed dockerfile, the following is fine:

# Build Stage FROM golang:1.23 AS builder WORKDIR /app # Copy go.mod and go.sum to download dependencies COPY go.mod go.sum ./ RUN go mod download # Copy application source code and build COPY . . RUN CGO_ENABLED=0 GOOS=linux go build -o server . # Runtime Stage FROM alpine:latest # Install runtime dependencies RUN apk --no-cache add ca-certificates # Copy the built application WORKDIR /root/ COPY --from=builder /app/server . # Expose the application port EXPOSE 8080 # Start the application CMD ["./server"]

JyotinderSingh · 2024-11-20T16:36:51Z

docs/src/content/docs/tutorials/url-shortener.md

+1. Refer to [DiceDB Installation Guide](get-started/installation) to get your DiceDB server up and running with a simple Docker command.
+2. Initialize a New Go Project
+3. Install DiceDB Go SDK and other required packges.
+    ```bash
+    go get github.com/dicedb/dicedb-go
+    go get github.com/gin-gonic/gin
+    go get github.com/google/uuid
+    ```


Suggested change

1. Refer to [DiceDB Installation Guide](get-started/installation) to get your DiceDB server up and running with a simple Docker command.

2. Initialize a New Go Project

3. Install DiceDB Go SDK and other required packges.

```bash

go get github.com/dicedb/dicedb-go

go get github.com/gin-gonic/gin

go get github.com/google/uuid

```

### 1. Install and Run DiceDB

Start a DiceDB server using Docker:

```bash

docker run -d -p 7379:7379 dicedb/dicedb

```

This command pulls the DiceDB Docker image and runs it, exposing it on port `7379`.

### 2. Initialize a New Go Project

Create a new directory for your project and initialize a Go module:

```bash

mkdir url-shortener

cd url-shortener

go mod init url-shortener

```

### 3. Install Required Packages

Install the DiceDB Go SDK and other dependencies:

```bash

go get github.com/dicedb/dicedb-go

go get github.com/gin-gonic/gin

go get github.com/google/uuid

```

JyotinderSingh · 2024-11-25T17:09:31Z

@Prachi-Jamdade hope you are doing well, are you actively working on this PR?

Prachi-Jamdade · 2024-11-25T17:14:25Z

Hey @JyotinderSingh, yes I'll push changes by tomorrow morning.

Got stuck in end sem exams. I'll address them quickly.

JyotinderSingh · 2024-11-25T17:17:04Z

Hey @JyotinderSingh, yes I'll push changes by tomorrow morning.

Got stuck in end sem exams. I'll address them quickly.

Thanks for the update! No rush.

Prachi-Jamdade · 2024-11-28T17:32:35Z

Hey @JyotinderSingh, addressed your changes.

feat: Add a tutorial example for URL Shortner built using DiceDB and Go

87976a4

JyotinderSingh self-requested a review November 9, 2024 15:43

JyotinderSingh requested changes Nov 9, 2024

View reviewed changes

Prachi-Jamdade added 2 commits November 9, 2024 23:13

fix: Address review changes

c1a2b47

chore: Add tutotial code to examples

30d29a3

fix: Remove project structure from tutorial doc

7a48a75

Prachi-Jamdade requested a review from JyotinderSingh November 10, 2024 05:15

everlearner reviewed Nov 11, 2024

View reviewed changes

Prachi-Jamdade added 2 commits November 14, 2024 21:54

fix: Fix typo in directory name, tutorial doc

af08fe8

chore: remove unnecessary mapping of longurl and shorturl in code, ma…

597ce6a

…ke functions unexported

Prachi-Jamdade requested a review from everlearner November 14, 2024 17:18

everlearner approved these changes Nov 14, 2024

View reviewed changes

JyotinderSingh requested changes Nov 20, 2024

View reviewed changes

JyotinderSingh reviewed Nov 20, 2024

View reviewed changes

Prachi-Jamdade and others added 2 commits November 28, 2024 22:49

Merge branch 'DiceDB:master' into docs/url-shortner-tutorial

244f9ea

chore: address review comments

620a4b1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add a tutorial example for URL Shortner built using DiceDB and Go #1259

feat: Add a tutorial example for URL Shortner built using DiceDB and Go #1259

Prachi-Jamdade commented Nov 9, 2024

JyotinderSingh left a comment

Prachi-Jamdade commented Nov 9, 2024

everlearner left a comment

everlearner Nov 11, 2024

everlearner Nov 11, 2024

everlearner Nov 11, 2024 •

edited

Loading

everlearner Nov 11, 2024

everlearner Nov 11, 2024

JyotinderSingh commented Nov 13, 2024

Prachi-Jamdade commented Nov 14, 2024

everlearner left a comment

Prachi-Jamdade commented Nov 16, 2024

JyotinderSingh commented Nov 19, 2024

JyotinderSingh left a comment

JyotinderSingh Nov 20, 2024

JyotinderSingh Nov 20, 2024

JyotinderSingh Nov 20, 2024

JyotinderSingh Nov 20, 2024

JyotinderSingh Nov 20, 2024

JyotinderSingh Nov 20, 2024

JyotinderSingh Nov 20, 2024

JyotinderSingh Nov 20, 2024

JyotinderSingh Nov 20, 2024

JyotinderSingh Nov 20, 2024

JyotinderSingh Nov 20, 2024

JyotinderSingh commented Nov 25, 2024

Prachi-Jamdade commented Nov 25, 2024

JyotinderSingh commented Nov 25, 2024

Prachi-Jamdade commented Nov 28, 2024

	dhost := "localhost"
	if val := os.Getenv("DICEDB_HOST"); val != "" {
	dhost = val
	}

	dport := "7379"
	if val := os.Getenv("DICEDB_PORT"); val != "" {
	dport = val
	}

	func CreateShortURL(c *gin.Context) {
	func createShortURL(c *gin.Context) {

	func RedirectURL(c *gin.Context) {
	func redirectURL(c *gin.Context) {

		requestBody.ID = shortID
		requestBody.ShortURL = "http://localhost:8080/" + shortID

		1. Go installed (at least version 1.18)
		2. DiceDB server running locally

-## Code overview
+## Writing the Code
+Create a file named `main.go` and add the following code:

-. Database Initialization: The `init()` function sets up a DiceDB client to connect to `localhost:7379`.
-. `CreateShortURL` Endpoint: Handles the `/shorten` route. It generates a unique ID, constructs the short URL, serializes the URL data, and saves it in DiceDB.
-. `RedirectURL` Endpoint: Handles the `/:id` route. It retrieves the original URL by the short ID from DiceDB and redirects the user to it.
-. Starting the Server: The `main` function starts the Gin server on port `8080`.
+### 1. Initialize the DiceDB Client
+We set up the DiceDB client in the `init` function:
+    ```go
+db = dicedb.NewClient(&dicedb.Options{
+    Addr: "localhost:7379",
+})
+    ```
+### 2. Create Short URL Endpoint
+- **Input Validation**: Ensures the `long_url` field is present.
+- **Short ID Generation**: Uses `uuid` to create a unique 8-character ID.
+- **Data Serialization**: Converts the `URL` struct to JSON.
+- **Data Storage**: Saves the JSON data in DiceDB with the `Set` command.
+- **Response**: Returns the generated short URL.
+### 3. Redirect to Original URL Endpoint
+- **Data Retrieval**: Fetches the URL data from DiceDB using the `Get` command.
+- **Data Deserialization**: Converts JSON back to the `URL` struct.
+- **Redirection**: Redirects the user to the `LongURL`.
+### 4. Start the Server
+The `main` function sets up the routes and starts the server on port `8080`.

-        Send a GET request to `/:id` with the short URL ID on Postman
-        OR
-        ```curl
-        curl -L http://localhost:8080/{short_id}
-        ```
+**Using `curl`:**
+    ```bash
+curl -L http://localhost:8080/abcd1234
+    ```
+**Using a Browser:**
+Navigate to:
+    ```
+http://localhost:8080/abcd1234
+    ```
+You should be redirected to `https://example.com`.

-. Refer to [DiceDB Installation Guide](get-started/installation) to get your DiceDB server up and running with a simple Docker command.
-. Initialize a New Go Project
-. Install DiceDB Go SDK and other required packges.
-    ```bash
-    go get github.com/dicedb/dicedb-go
-    go get github.com/gin-gonic/gin
-    go get github.com/google/uuid
-    ```
+### 1. Install and Run DiceDB
+Start a DiceDB server using Docker:
+    ```bash
+docker run -d -p 7379:7379 dicedb/dicedb
+    ```
+This command pulls the DiceDB Docker image and runs it, exposing it on port `7379`.
+### 2. Initialize a New Go Project
+Create a new directory for your project and initialize a Go module:
+    ```bash
+mkdir url-shortener
+cd url-shortener
+go mod init url-shortener
+    ```
+### 3. Install Required Packages
+Install the DiceDB Go SDK and other dependencies:
+    ```bash
+go get github.com/dicedb/dicedb-go
+go get github.com/gin-gonic/gin
+go get github.com/google/uuid
+    ```

feat: Add a tutorial example for URL Shortner built using DiceDB and Go #1259

Are you sure you want to change the base?

feat: Add a tutorial example for URL Shortner built using DiceDB and Go #1259

Conversation

Prachi-Jamdade commented Nov 9, 2024

JyotinderSingh left a comment

Choose a reason for hiding this comment

Prachi-Jamdade commented Nov 9, 2024

everlearner left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

everlearner Nov 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JyotinderSingh commented Nov 13, 2024

Prachi-Jamdade commented Nov 14, 2024

everlearner left a comment

Choose a reason for hiding this comment

Prachi-Jamdade commented Nov 16, 2024

JyotinderSingh commented Nov 19, 2024

JyotinderSingh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JyotinderSingh commented Nov 25, 2024

Prachi-Jamdade commented Nov 25, 2024

JyotinderSingh commented Nov 25, 2024

Prachi-Jamdade commented Nov 28, 2024

everlearner Nov 11, 2024 •

edited

Loading