An open API service indexing awesome lists of open source software.

https://github.com/sugidaffection/rust-shortlink

a rust url shortener web application
https://github.com/sugidaffection/rust-shortlink

actix actix-web link-shortener rust rust-lang shortlink shorturl url-shortener

Last synced: about 1 month ago
JSON representation

a rust url shortener web application

Awesome Lists containing this project

README

          

# Rust Shortlink

![workflow](https://github.com/sugidaffection/rust-shortlink/actions/workflows/rust.yml/badge.svg)

![screenshot](screenshots/home.png)

## Table of Contents

- [About](#about)
- [Getting Started](#getting_started)

## About

A simple url shortener web application. Save and manage your long url.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

What things you need to install the software and how to install them:

```
postgresql ^=14
rust ^=1.58
cargo-leptos
```

Additionally, if you are using a Linux-based system, you need to install libpq-dev for PostgreSQL support:

```
sudo apt update
sudo apt install libpq-dev
```

Install cargo-leptos:

```
cargo install cargo-leptos
```

### Installing

Clone the repository and install dependencies:

```
git clone
cd rust-shortlink
```

### Run Server

First, setup your environment:

```
cp .env.example .env
# Edit .env with your database settings
```

For development with hot-reload:

```
cargo leptos watch
```

For production build:

```
cargo leptos build --release
```

The server will start at `http://localhost:3000` by default.