Code Monkey home page Code Monkey logo

short-link's Introduction

short-link

Short link server

中文版

Build

build for your default target: cargo build --release

build for Linux (musl): ./build.sh

Usage

  1. Build this program and copy the release executable short_link and ShortLink.toml to your server.

  2. Install postgresql and create a user and database:

$ sudo -u postgres psql
psql (15.6 (Debian 15.6-0+deb12u1))
Type "help" for help.

postgres=# create user USER_NAME password 'STRONG_PASSWORD';
CREATE ROLE
postgres=# create database DATABASE_NAME owner USER_NAME;
CREATE DATABASE
  1. Modify your config file ShortLink.toml:
database_url = "postgres://USER_NAME:[email protected]/DATABASE_NAME"
host = "127.0.0.1"  # this short_link server will listen on `http://127.0.0.1`
port = 3000  # and the port will be `3000`
base = "/"  # all routes will be based on `/`
...
[service]
secret = "ANOTHER_STRONG_PASSWORD"
...
  1. Run the short_link executable.

  2. Refer the Admin API example

License

Apache 2.0

Copyright 2024 @sb-child

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

short-link's People

Contributors

sb-child avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.