Skip to content

README.md

Latest commit

 

History

History
72 lines (42 loc) · 2.38 KB

README.md

File metadata and controls

72 lines (42 loc) · 2.38 KB

Nounly

1-click-deploy

Nounly (also known as Noun.ly) is a URL shortener website built with Go, JavaScript and Redis, and can be deployed with Defang as a sample.

The URL shortener appends a noun to the end of a Defang-deployed URL to create the new shortened URL. For reference, you can view the real Noun.ly website here.

"Share the web through words." - Creator of Nounly

Prerequisites

  1. Download Defang CLI
  2. (Optional) If you are using Defang BYOC authenticate with your cloud provider account
  3. (Optional for local development) Docker CLI

Development

To run the application locally, you can use the following command:

docker compose up --build

Configuration

For this sample, you will need to provide the following configuration:

Note that if you are using the 1-click deploy option, you can set these values as secrets in your GitHub repository and the action will automatically deploy them for you.

PROJECT_HONEYPOT_KEY

A Project Honey Pot API key that is used for anti-spamming. It is optional, but please include a non-empty string value.

defang config set PROJECT_HONEYPOT_KEY

SHARED_SECRETS

A JSON object string of shared secrets that are used for API clients. It is optional, and the default value is {} if you do not have any shared secrets.

defang config set SHARED_SECRETS

Deployment

Note

Download Defang CLI

Defang Playground

Deploy your application to the Defang Playground by opening up your terminal and typing:

defang compose up

BYOC

If you want to deploy to your own cloud account, you can use Defang BYOC.

Title: Nounly

Short Description: A URL shortener website built with Go, JavaScript, and Redis.

Tags: Go, JavaScript, Redis, URL shortener

Languages: golang, javascript