chen-ky/abbr.ninja-web

Frontend server for abbr.ninja

abbr.ninja Frontend

This is the frontend code for the link shortener on abbr.ninja.

Source code for:

• API documentation
• API server

Building the Container

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

1. Clone this repository. git clone https://github.com/chen-ky/abbr.ninja-web.git
2. Change directory into the cloned repository. cd abbr.ninja-web
3. Build the container with the provided Dockerfile. podman build -t <INSERT_CONTAINER_TAG_NAME> .
4. Run the newly built container. podman run -p 8080:8080 -e API_BASE_URL="<INSERT_URL_FOR_API_SERVER>" -d -t <INSERT_CONTAINER_TAG_NAME>"
5. You should be able to go to http://localhost:8080 for the webpage.

Environment Variables for Container

• API_BASE_URL (Required): The URL endpoint for the API server for API calls. Example: https://api.abbr.ninja/api/v1
• HOST (Optional): IP address the server will listen on. Default: 0.0.0.0
• PORT (Optional): Network port that the server will listen on. Default: 8080

Deployment Recommendation

• A nginx reverse proxy pointed to this server is recommended since this server does not support configuration for TLS/SSL and for higher performance. How to Configure a Nginx HTTPs Reverse Proxy on Ubuntu Bionic - Scaleway

Donations

Feel free to donate if you find this helpful!

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