Skip to content

Latest commit

 

History

History
52 lines (40 loc) · 2.77 KB

README.md

File metadata and controls

52 lines (40 loc) · 2.77 KB
Raw

Kansa Client

These are the front-end clients for Kansa, a convention member management system.

Getting Started

Use npm install to fetch the required dependencies, and see package.json for the various npm run targets; the default npm start uses webpack-dev-server to incrementally re-build and serve the client code at http://localhost:8080/ during development.

To use the client, you'll need a Kansa server that you can connect to. In development, the server is assumed to run at its default local address https://localhost:4430/; in production, the default is to use the same host that serves the client code. To specify a different target, use the API_HOST environment variable:

The default dev-configured server provides an admin account with which you may log in by visiting: http://localhost:8080/#/login/[email protected]/key

API_HOST=members.worldcon.fi npm start

For other environment variables, see webpack.config.js. If you're running Docker in a VM and have the DOCKER_HOST environment variable set, that will replace the default localhost hostname.

IMPORTANT: As all server connections require https and the default development server uses a self-signed certificate for localhost, you'll need to open it directly at https://localhost:4430/ to trigger your browser's functionality for bypassing the warning. Until you do that, your browser will silently block the client's API calls:

  • Chrome: Click on Advanced, then Proceed to localhost:4430. Alternatively, go to chrome://flags/#allow-insecure-localhost and enable the option to "Allow invalid certificates for resources loaded from localhost"
  • Firefox: Click on I Understand the Risks, then Add Exception...., then Get Certificate, and finally Confirm Security Exception
  • IE: Click on Continue to this website (not recommended)
  • Safari: Click on Show Certificate, Always Trust "example.com" when connecting to "example.com", then Continue

Also important: the API server by default self-hosts a client that uses the latest-release production code hosted on GitHub Pages, so you should make sure that after bypassing the certificate warning you navigate to your actual client development version, at http://localhost:8080/.

Admin Interfaces

The Kansa and Hugo admin interfaces are built partly from the same sources as the public-facing site, and are a part of the build targets specified in the Webpack config. Both of these require first logging in using a login link. In dev mode: