A React-based client application for Shlink
Find a file
2020-06-06 08:50:37 +02:00
.github Added github funding 2019-10-22 19:33:59 +02:00
config Updated nginx.conf (optimization for future) 2020-01-31 01:36:17 +01:00
dist Created dist dir 2018-08-05 11:39:49 +02:00
public Update .htaccess 2020-01-31 01:29:41 +01:00
scripts Fixed version not properly provided to docker image 2020-06-06 08:50:37 +02:00
src Replaced if/else by functional matcher 2020-05-31 20:16:15 +02:00
test Improved logic to determine default grouping for line chart based on how old the visits are 2020-05-31 20:03:59 +02:00
.dockerignore Simplified docker image building, as it will now be run in a different job as the dist file release 2020-05-17 10:13:33 +02:00
.eslintrc Tested how hilghlighted data behaves on GraphCards 2020-04-09 09:44:14 +02:00
.gitignore Catched error when loading servers from a servers.json file 2019-04-28 13:07:55 +02:00
.scrutinizer.yml Rolled back node version for scrutinizer 2020-05-17 10:28:49 +02:00
.stylelintrc Added stylelint config 2018-08-25 10:22:25 +02:00
.travis.yml Fixed travis config error 2020-05-17 10:16:53 +02:00
CHANGELOG.md Fixed version not properly provided to docker image 2020-06-06 08:50:37 +02:00
docker-compose.override.yml.dist Replaced yarn by npm 2019-04-14 21:58:10 +02:00
docker-compose.yml Updated runtimne versions 2020-05-17 10:04:05 +02:00
Dockerfile Simplified docker image building, as it will now be run in a different job as the dist file release 2020-05-17 10:13:33 +02:00
indocker Created Storage service test 2018-12-19 20:43:55 +01:00
jest.config.js Updated coding styles and test configs 2019-01-05 23:16:13 +01:00
LICENSE Updated date on license file 2020-01-19 21:20:32 +01:00
package-lock.json Updated to stryker 3 2020-05-31 09:27:42 +02:00
package.json Updated ScrollToTop to be a functional component 2020-05-31 09:50:00 +02:00
README.md Added app gif to readme 2020-03-16 18:53:06 +01:00
shlink-web-client.gif Added app gif to readme 2020-03-16 18:53:06 +01:00
stryker.conf.js Updated to stryker 3 2020-05-31 09:27:42 +02:00

shlink-web-client

Build Status Code Coverage Scrutinizer Code Quality GitHub release Docker pulls GitHub license Paypal Donate

A ReactJS-based progressive web application for Shlink.

shlink-web-client

Installation

There are three ways in which you can use this application.

The easiest way to use shlink-web-client is by just going to https://app.shlink.io.

The application runs 100% in the browser, so you can safely access any shlink instance from there.

Docker image

If you want to deploy shlink-web-client in a container-based cluster (kubernetes, docker swarm, etc), just pick the shlinkio/shlink-web-client image and do it.

It's a lightweight nginx:alpine image serving the static app on port 80.

Self-hosted

If you want to self-host it yourself, get the latest release and download the distributable zip file attached to it (shlink-web-client_X.X.X_dist.zip).

The package contains static files only, so just put it in a folder and serve it with the web server of your choice.

Considerations:

  • Provided dist files are configured to be served from the root of your domain. If you need to serve shlink-web-client from a subpath, you will have to build it yourself following these steps.
  • The app has a client-side router that handles dynamic paths. Because of that, you need to configure your web server to fall-back to the index.html file when requested files do not exist.
    • If you use Apache, you are covered, since the project includes an .htaccess file which already does this.
    • If you use nginx, you can see how it's done for the docker image and do the same.

Pre-configuring servers

The first time you access shlink-web-client from a browser, you will have to configure the list of shlink servers you want to manage, and they will be saved in the local storage.

Those servers can be exported and imported in other browsers, but if for some reason you need some servers to be there from the beginning, starting with shlink-web-client 2.1.0, you can provide a servers.json file in the project root folder (the same containing the index.html, favicon.ico, etc) with a structure like this:

[
  {
    "name": "Main server",
    "url": "https://doma.in",
    "apiKey": "09c972b7-506b-49f1-a19a-d729e22e599c"
  },
  {
    "name": "Local",
    "url": "http://localhost:8080",
    "apiKey": "580d0b42-4dea-419a-96bf-6c876b901451"
  }
]

The list can contain as many servers as you need.

If you are using the shlink-web-client docker image, you can mount the servers.json file in a volume inside /usr/share/nginx/html, which is the app's document root inside the container.

docker run --name shlink-web-client -p 8000:80 -v ${PWD}/servers.json:/usr/share/nginx/html/servers.json shlinkio/shlink-web-client

Serve project in subpath

Official distributable files have been built so that they are served from the root of a domain.

If you need to host shlink-web-client yourself and serve it from a subpath, follow these steps:

  • Download shlink-web-client source code for the version you want to build.
  • Decompress the file and cd into the resulting folder.
  • Open the package.json file in the root of the project, locate the homepage property and replace the value (which should be an empty string) by the path from which you want to serve shlink-web-client.
    • For example: "homepage": "/my-projects/shlink-web-client",.
  • Build the project:
    • For classic hosting:
      • Download node 10.15 or later.
      • Install project dependencies by running npm install.
      • Build the project by running npm run build.
      • Once the command finishes, you will have a build folder with all the static assets you need to run shlink-web-client. Just place them wherever you want them to be served from.
    • For docker image:
      • Download docker.
      • Build the docker image by running docker build . -t shlink-web-client.
      • Once the command finishes, you will have an image with the name shlink-web-client.