Skip to content

chen-ky/abbr.ninja-api-server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

abbr.ninja API Server

This is the API server for the link shortener on abbr.ninja.

API endpoint documentation

Source code for:

Dependencies

Refer to requirements.txt.

Building the Container

podman was used to run and build the container but this should also work for docker.

  1. Populate config.toml with your desired settings.
  2. Clone from the API doc repository and build the document.
  3. Copy the build directory from the API doc directory to this directory where the path should be ./doc/build.
  4. Run podman build -t <INSERT_CONTAINER_NAME> . in the root directory of the repository containing the Dockerfile.
  5. Start your container by podman run --network <INSERT_CONTAINER_NETWORK_NAME> -p <INSERT_HOST_PORT>:8081 -d -t <INSERT_CONTAINER_NAME>

You would also need a MariaDB server running and a database named uri_shortener created.

Deployment Recommendation

Donations

Feel free to donate if you find this helpful!

  • BTC:
    • bc1qww8sktvenl044juafgvt068yah9dxuwrhht4kq
    • 16G7WnKzNdYc48NtEeiVuLNeaLcoXBw1K4
  • ETH:
    • 0x5d67690768F0Fc4780c578393Ca567e5bCb38378