mirrors/shlink-web-client
1
0
Fork 0
mirror of https://github.com/shlinkio/shlink-web-client.git synced 2024-12-23 09:30:31 +03:00
Code Issues Projects Releases Packages Wiki Activity
shlink-web-client/README.md
Alejandro Celaya f9360683e9 Added docker build status badge
2019-01-07 10:37:24 +01:00

3.7 KiB
Raw Blame History

shlink-web-client

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

A ReactJS-based progressive web application for Shlink.

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 use that instance and access any shlink instance from it.

  • Self hosting the application 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.

    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 simple steps.

  • Use the official docker image

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

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

Serve project in subpath

Official distributable files have been build 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 node 10.4 or later (if you don't have it yet).
  • Download yarn package manager.
  • Download shlink-web-client source files for the version you want to build.
  • Decompress the file and cd into the resulting folder.
  • Install project dependencies by running yarn install.
  • 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 distributable contents by running yarn 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.