tinybits

command module
v0.0.0-...-927a41b Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 14, 2024 License: MIT Imports: 12 Imported by: 0

README

TinyBits

A URL shortener powered by Golang and Remix for efficient link management

GitHub contributors GitHub issues GitHub pull request

[!IMPORTANT] The client part is WIP!

Structure

TinyBits consists of two parts:

api - A Golang server that handles the URL shortening and redirection
client - A Remix app that provides a UI for managing the shortened URLs

Getting Started

Prerequisites

How to run

Do setup the .env file in the root directory before running the app check .env.example for reference

Backend

# For live development with auto reload
go install github.com/cosmtrek/air@latest

# Start the server with air
air
# Start the server manually
go run .

Frontend

# Change directory
cd client
# Install dependencies
pnpm install
# Start the app
pnpm dev

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
api
db
lib

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL