Note

Freeshard used to be called Portal. Don't be confused if you see the old name in the code or documentation. Our goal is to update everything step by step.

Web Terminal

Each Shard is controlled by one or multiple terminals, trusted devices that have been paired with the Shard. This terminal comes in the form of a web application.

Project setup

npm install

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Lints and fixes files

npm run lint

Development setup

Develop with a real Shard

1. Create a Shard if you don't have one yet (e.g. at trial.getportal.org)
2. Enter its domain as the proxy target in vue.config.js
3. Make sure that the pathRewrite option is disabled
4. Start the proxy together with the hot-reloading server with npm run serve

Using shard_core running on the dev machine

1. Start shard_core, look for instructions in its readme on how to do that
2. Make sure that http://127.0.0.1:8080 is the proxy target in vue.config.js
3. Make sure that the pathRewrite option is enabled
4. Start the proxy together with the hot-reloading server with npm run serve
5. Look up the shard's URL in the logs right below where the logo is printed. It should be in the format <shard_id>.<DNS_ZONE>. Open it in your browser at port 8081
6. Get a pairing code at http://127.0.0.1:8080/protected/terminals/pairing-code