Jacob-Ernst/short-links-worker

Link shortener built with Cloudflare Workers.

Short Links Worker

Link shortener built with Cloudflare Workers.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. License
6. Contact

About The Project

Link shortener built with Cloudflare Workers and TypeScript.

(back to top)

Built With

• 
• 

(back to top)

Getting Started

To get started, make sure that you have the Prerequisites installed or set up. Then follow the directions under Installation.

Prerequisites

• Node.js 20.x
• A Cloudflare account
• Task (available in Homebrew as "go-task")

Installation

1. Clone the repo

   git clone https://github.com/Jacob-Ernst/short-links-worker.git

2. Create a API token for Cloudflare
3. Create a copy of .envrc.example

   task build:envrc

4. Copy working ENV variables into .envrc
5. Setup Install dependencies and setup project

   task dev:setup

6. Run the Worker in development mode to see if everything is working

   task start

(back to top)

Usage

To run the project for local development run the following:

task start

The server should now be accessible by visiting: http://127.0.0.1:8787.

To stop the development server, press the "x" key.

(back to top)

Roadmap

• Feature 1
• Feature 2
• Feature 3
  • Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/Jacob-Ernst/short-links-worker

(back to top)