Build an Image Search App with Koyeb, AWS Rekognition, and Algolia

Last updated about 1 month ago

Introduction

This guide demonstrates how to create an image search application using the Koyeb Serverless Platform, AWS Rekognition to detect labels, and Algolia to index and search images labels.

Once you have completed this tutorial, you have a Next.js app up & running allowing you to search images by labels and upload new images. Each time an image is uploaded, a Koyeb function is triggered to detect image labels using AWS Rekognition and index the result in Algolia.

You can preview the app we will build here.

Schema

  • Koyeb is a serverless data processing platform offering a simple way to deploy and trigger functions and docker containers based on events.
  • AWS Rekognition is an image detection service provided by Amazon Web Services that employs deep learning technology to analyze image content.
  • Algolia is a powerful hosted search API that provides the resources & tools to create a fast and relevant search.
  • Next.js is a React Framework offering many features such as hybrid static & server rendering, smart bundling, route pre-fetching, and more.

Requirements

Steps

To create the image search application, you need to follow these steps:

  1. Create a Koyeb Store to Upload and Retrieve Files
  2. Generate AWS Rekognition Credentials
  3. Configure Algolia
  4. Deploy the Processing Function

Create a Koyeb Store to Upload and Retrieve Files

The first step is to create a Koyeb Store to upload and serve images. Koyeb natively provides an S3-compatible API allowing you to manage your data programmatically using any S3-compatible SDKs and tools. We will use the Koyeb S3 API endpoint to upload and serve images in our app.

In this guide, we use a Koyeb Managed Store for simplicity, but you can connect your own Cloud Storage Provider to use it directly. You can refer to this documentation to get started with this method.

To create a new Koyeb Managed Store, go to the Koyeb Control Panel.

  1. Click Stores located in the menu on the left-side of the Koyeb Control Panel.
  2. On the Stores page, click Create Store.
  3. On the Store creation page, select Koyeb as the cloud service provider.
  4. Name your Store. Either keep the automatically generated name or enter the name you want to use for this Store.
  5. Click Create Store

We have now created a Koyeb Managed Store and can go to the next step.

Generate AWS Rekognition Credentials

As our Koyeb function uses AWS Rekognition to detect labels in images, we need to generate AWS Credentials to access the service.

Below, we generate new credentials scoped to the AWS Rekognition API and create new Secrets to store these credentials in the Koyeb console so our function can access them at runtime.

From the AWS Console

  1. Go to Identity and Access Management (IAM) dashboard
  2. Under Access management, click Users

AWS IAM Dashboard

  1. Click Add user

AWS Add User

  1. Enter the username you want to use
  2. Select Programmatic Access
  3. Click Next: Permissions

AWS Step 1

  1. Select Attach existing policies directly
  2. Enter AmazonRekognitionReadOnlyAccess into the search bar
  3. Click the box for AmazonRekognitionReadOnlyAccess
  4. Click Next: Tags
  5. Add tags to remember where these credentials are used (Optional)
  6. Click Next: Review

AWS Step 3

  1. Review the information you have entered
  2. Click Create user

AWS Step 4

You have now successfully configured AWS Rekognition credentials. Save them in a secure place, we will need them in the next step.

From the Koyeb Console

  1. Go to your Koyeb Console.
  2. Click Secrets in the left-side menu.
  3. Click New on the Secrets page to create the first Secret. A modal appears.

Koyeb Console Secrets

  1. Enter the name of this Secret, for example: aws-reko-access-key.
  2. Enter the AWS access key ID that you just created as the value.
  3. Click Submit.

Koyeb Console Secrets

  1. Click Create to configure another Secret; this one is for your AWS secret access key value.
  2. Enter the name of this Secret, for example: aws-reko-secret-key.
  3. Enter the AWS secret key that you just created as the value.
  4. Click Submit.

We now have generated AWS Rekognition credentials and created the Koyeb Secrets required by our function to perform the label detection each time a new image is uploaded.

Configure Algolia

The next step is to configure Algolia by creating a new index to store image labels detect by AWS Rekognition.

Create an Index

Algolia new index

  1. Click Indices in the left-side menu.
  2. Click Create index.
  3. A model appears and asks for an index name, for this demo we name it: image-search.
  4. Click Submit.

Configure Koyeb Secrets

Now our index is created, we need to create new Koyeb Secrets to allow our function to index detected labels into Algolia at runtime.

From the Algolia console

Algolia api keys

  1. Click API Keys in the left-side menu.
  2. Copy the Application ID, Search-Only API Key, and the Admin API KEY values.

Make sure to copy these values in a safe place, we will need them in the next steps.

From the Koyeb Console

  1. Go to your Koyeb Console.
  2. Click Secrets in the left-side menu.
  3. Click New on the Secrets page to create a Secret. A modal appears.

Koyeb Console Secrets

  1. Enter the name of this Secret, for example: algolia-app-id.
  2. Enter the Algolia Application ID that you just located the value.
  3. Click Submit.
  4. Click Create to configure another Secret; this one is for your Algolia API ID key value.
  5. Enter the name of this Secret, for example: algolia-api-key.
  6. Enter the Algolia API key that you just located as the value.
  7. Click Submit.

From there, all the required configuration is ready. We can now deploy our function and view what happens.

Deploy the Processing Function

The best part starts now! Fork the GitHub repository containing the Koyeb processing function and demo app here.

The GitHub repository contains:

  • A koyeb.yaml file: used to configure and deploy the function image-search.js on Koyeb. The koyeb.yaml file contains environment variables required by the function to run properly, the Koyeb Store the function must access to retrieve and process the image, and the event triggering the function.
  • A image-search.js file: The function to detect image labels and index them on Algolia. This function is triggered each time a new image is uploaded to the Koyeb Store.

All other files present in the repository are used to run the Next.js app. The app lets you explore the Koyeb Store images and upload new images that will be automatically processed by the function running on Koyeb.

Below is the repository structure:

1## Koyeb folders and files
2koyeb.yaml
3koyeb-functions
4└── image-search.js
5## Next.js app folders & files
6components
7├── instant-search.js
8└── uploader.js
9pages
10├── _app.js
11├── api
12│   ├── images
13│   │   ├── [key].js
14│   │   └── index.js
15│   └── upload.js
16└── index.js
17public
18├── favicon.ico
19└── vercel.svg
20styles
21└── tailwind.css
22package.json
23node_modules
24
  1. Edit the koyeb.yaml

Open the koyeb.yaml and replace the REPLACE_ME_WITH_YOUR_KOYEB_STORE_NAME with your Koyeb Store name. If you named the secrets as mentioned above, there is nothing else to edit.

1functions:
2  - name: image-search
3    runtime: nodejs14
4    handler: koyeb-functions/image-search.handler
5    env:
6      AWS_ACCESS_KEY:
7        value_from_secret: aws-reko-access-key
8      AWS_SECRET_KEY:
9        value_from_secret: aws-reko-secret-key
10      ALGOLIA_APP_ID:
11        value_from_secret: algolia-app-id
12      ALGOLIA_API_KEY:
13        value_from_secret: algolia-api-key
14      ALGOLIA_INDEX:
15        value_from_secret: algolia-index
16    volumes:
17      - store: REPLACE_ME_WITH_YOUR_KOYEB_STORE_NAME
18    events:
19      - cloudevent:
20          expression: |
21            event.source == "koyeb.com/gateway" &&
22            event.subject == "REPLACE_ME_WITH_YOUR_KOYEB_STORE_NAME" &&
23            event.type.matches("s3:ObjectCreated:.*") &&
24            data.object.key.matches("([^\\s]+(\\.(?i)(jpe?g|png))$)")
25
  1. Create and deploy a new Stack

On the Koyeb console, click the Create button on the top-right and select Stack. You land on the Stack creation page. Choose GitHub repository as the way to manage the Stack and select the repository you previously forked in the dropdown. Click Create Stack.

  1. Go to the Store you created and upload some images

Go to the Store you created and upload some images. If you followed all steps, your Stack function is executed for each image uploaded, detect labels, and index them into Algolia.

In the Algolia control panel, you should see the list of images with their detected labels indexed.

Run the Next.js app

The final step is to run the Next.js app to showcase the end-to-end use-case.

Generate Koyeb S3 credentials

  1. In the Koyeb Console, click API in the left-side menu.
  2. Click New in the S3 Credentials section.
  3. Give a name to the credentials to remember what are they used for
  4. Copy the access_key and secret_key

Configure the Next.js app

In the repository you previously forked, copy the env.example to .env.local, and edit the variable values with your own:

1NEXT_PUBLIC_ALGOLIA_APP_ID=REPLACE_ME
2NEXT_PUBLIC_ALGOLIA_SEARCH_API_KEY=REPLACE_ME
3NEXT_PUBLIC_ALGOLIA_INDEX=REPLACE_ME
4KOYEB_S3_ACCESS_KEY=REPLACE_ME
5KOYEB_S3_SECRET_KEY=REPLACE_ME
6KOYEB_STORE=REPLACE_ME
7

Run the app

In the terminal, run the following command to start the app:

  • yarn install to install the project dependencies
  • yarn start to start the application

In your browser, open http://localhost:3000, you land on a page listing your Koyeb Store images. You can search and upload new images. Each time a new image is uploaded, the function will be executed to detect labels and index the result in Algolia.


Ready to get started?

Get in touch or create an account and deploy your serverless stack in minutes.

footer-frame