···

       
1
       
 
       
# SimpleLink

     

       
0
       
 
       

     

       
2
       
 
       
A very performant and light (6mb in memory) link shortener and tracker. Written in Rust and React and uses Postgres.

     

       
3
       
 
       


     

       
4
       
 
       
![MainView](readme_img/mainview.jpg)

     
···

       
8
       
 
       
## Build

     

       
9
       
 
       


     

       
10
       
 
       
### From Source

     

       
0
       
 
       

     

       
11
       
 
       
First configure .env.example and save it to .env

     

       
12
       
 
       


     

       
13
       
 
       
If DATABASE_URL is set, it will connect to a Postgres DB. If blank, it will use an sqlite db in /data

     
···

       
15
       
 
       
```bash

     

       
16
       
 
       
#set api-domain to where you will be deploying the link shortener, eg: link.example.com, default is localhost:8080

     

       
17
       
 
       
git clone https://github.com/waveringana/simplelink && cd simplelink

     

       
18
       
-
       
./build.sh api-domain=localhost:8080

     

       
19
       
 
       
cargo run

     

       
20
       
 
       
```

     

       
21
       
 
       


     

       
22
       
 
       
On an empty database, an admin-setup-token.txt is created as well as pasted into the terminal output. This is needed to make the admin account.

     

       
23
       
 
       


     

       
24
       
 
       
Alternatively if you want a binary form

     

       
0
       
 
       

     

       
25
       
 
       
```bash

     

       
26
       
 
       
./build.sh --binary

     

       
27
       
 
       
```

     

       
0
       
 
       

     

       
28
       
 
       
then check /target/release for the binary named `SimpleGit`

     

       
29
       
 
       


     

       
30
       
 
       
### From Docker

     

       
0
       
 
       

     

       
31
       
 
       
```bash

     

       
32
       
-
       
docker build --build-arg API_URL=http://localhost:8080 -t simplelink .

     

       
33
       
 
       
docker run -p 8080:8080 \

     

       
34
       
 
       
    -e JWT_SECRET=change-me-in-production \

     

       
35
       
 
       
    -v simplelink_data:/data \

     
···

       
37
       
 
       
```

     

       
38
       
 
       


     

       
39
       
 
       
### From Docker Compose

     

       
0
       
 
       

     

       
40
       
 
       
Adjust the included docker-compose.yml to your liking; it includes a postgres config as well.

     

···

       
1
       
 
       
# SimpleLink

     

       
2
       
+
       


     

       
3
       
 
       
A very performant and light (6mb in memory) link shortener and tracker. Written in Rust and React and uses Postgres.

     

       
4
       
 
       


     

       
5
       
 
       
![MainView](readme_img/mainview.jpg)

     
···

       
9
       
 
       
## Build

     

       
10
       
 
       


     

       
11
       
 
       
### From Source

     

       
12
       
+
       


     

       
13
       
 
       
First configure .env.example and save it to .env

     

       
14
       
 
       


     

       
15
       
 
       
If DATABASE_URL is set, it will connect to a Postgres DB. If blank, it will use an sqlite db in /data

     
···

       
17
       
 
       
```bash

     

       
18
       
 
       
#set api-domain to where you will be deploying the link shortener, eg: link.example.com, default is localhost:8080

     

       
19
       
 
       
git clone https://github.com/waveringana/simplelink && cd simplelink

     

       
20
       
+
       
./build.sh

     

       
21
       
 
       
cargo run

     

       
22
       
 
       
```

     

       
23
       
 
       


     

       
24
       
 
       
On an empty database, an admin-setup-token.txt is created as well as pasted into the terminal output. This is needed to make the admin account.

     

       
25
       
 
       


     

       
26
       
 
       
Alternatively if you want a binary form

     

       
27
       
+
       


     

       
28
       
 
       
```bash

     

       
29
       
 
       
./build.sh --binary

     

       
30
       
 
       
```

     

       
31
       
+
       


     

       
32
       
 
       
then check /target/release for the binary named `SimpleGit`

     

       
33
       
 
       


     

       
34
       
 
       
### From Docker

     

       
35
       
+
       


     

       
36
       
 
       
```bash

     

       
37
       
+
       
docker build --build-arg -t simplelink .

     

       
38
       
 
       
docker run -p 8080:8080 \

     

       
39
       
 
       
    -e JWT_SECRET=change-me-in-production \

     

       
40
       
 
       
    -v simplelink_data:/data \

     
···

       
42
       
 
       
```

     

       
43
       
 
       


     

       
44
       
 
       
### From Docker Compose

     

       
45
       
+
       


     

       
46
       
 
       
Adjust the included docker-compose.yml to your liking; it includes a postgres config as well.

     

···

       
1
       
 
       
#!/bin/bash

     

       
2
       
 
       


     

       
3
       
 
       
# Default values

     

       
4
       
-
       
API_URL="http://localhost:8080"

     

       
5
       
 
       
RELEASE_MODE=false

     

       
6
       
 
       
BINARY_MODE=false

     

       
7
       
 
       


     
···

       
9
       
 
       
for arg in "$@"

     

       
10
       
 
       
do

     

       
11
       
 
       
    case $arg in

     

       
12
       
-
       
        api-domain=*)

     

       
13
       
-
       
        API_URL="${arg#*=}"

     

       
14
       
-
       
        shift

     

       
15
       
-
       
        ;;

     

       
16
       
 
       
        --release)

     

       
17
       
 
       
        RELEASE_MODE=true

     

       
18
       
 
       
        shift

     
···

       
24
       
 
       
    esac

     

       
25
       
 
       
done

     

       
26
       
 
       


     

       
27
       
-
       
echo "Building project with API_URL: $API_URL"

     

       
28
       
 
       
echo "Release mode: $RELEASE_MODE"

     

       
29
       
 
       


     

       
30
       
 
       
# Check if cargo is installed

     
···

       
42
       
 
       
# Build frontend

     

       
43
       
 
       
echo "Building frontend..."

     

       
44
       
 
       
# Create .env file for Vite

     

       
45
       
-
       
echo "VITE_API_URL=$API_URL" > frontend/.env

     

       
46
       
 
       


     

       
47
       
 
       
# Install frontend dependencies and build

     

       
48
       
 
       
cd frontend

     

···

       
1
       
 
       
#!/bin/bash

     

       
2
       
 
       


     

       
3
       
 
       
# Default values

     

       
4
       
+
       
#API_URL="http://localhost:8080"

     

       
5
       
 
       
RELEASE_MODE=false

     

       
6
       
 
       
BINARY_MODE=false

     

       
7
       
 
       


     
···

       
9
       
 
       
for arg in "$@"

     

       
10
       
 
       
do

     

       
11
       
 
       
    case $arg in

     

       
12
       
+
       
        #api-domain=*)

     

       
13
       
+
       
        #API_URL="${arg#*=}"

     

       
14
       
+
       
        #shift

     

       
15
       
+
       
        #;;

     

       
16
       
 
       
        --release)

     

       
17
       
 
       
        RELEASE_MODE=true

     

       
18
       
 
       
        shift

     
···

       
24
       
 
       
    esac

     

       
25
       
 
       
done

     

       
26
       
 
       


     

       
27
       
+
       
#echo "Building project with API_URL: $API_URL"

     

       
28
       
 
       
echo "Release mode: $RELEASE_MODE"

     

       
29
       
 
       


     

       
30
       
 
       
# Check if cargo is installed

     
···

       
42
       
 
       
# Build frontend

     

       
43
       
 
       
echo "Building frontend..."

     

       
44
       
 
       
# Create .env file for Vite

     

       
45
       
+
       
#echo "VITE_API_URL=$API_URL" > frontend/.env

     

       
46
       
 
       


     

       
47
       
 
       
# Install frontend dependencies and build

     

       
48
       
 
       
cd frontend

     

···

       
22
       
 
       
    build:

     

       
23
       
 
       
      context: .

     

       
24
       
 
       
      dockerfile: Dockerfile

     

       
25
       
-
       
      args:

     

       
26
       
-
       
        - API_URL=${API_URL:-http://localhost:3000}

     

       
27
       
 
       
    container_name: shortener-app

     

       
28
       
 
       
    ports:

     

       
29
       
 
       
      - "8080:8080"

     

···

       
22
       
 
       
    build:

     

       
23
       
 
       
      context: .

     

       
24
       
 
       
      dockerfile: Dockerfile

     

       
0
       
 
       

     

       
0
       
 
       

     

       
25
       
 
       
    container_name: shortener-app

     

       
26
       
 
       
    ports:

     

       
27
       
 
       
      - "8080:8080"