Skip to content

Latest commit

 

History

History
216 lines (148 loc) · 10.8 KB

README.md

File metadata and controls

216 lines (148 loc) · 10.8 KB
Raw

HestiaLabs Experiences

npm node

The experiences developed by HestiaLabs are targeted for any user willing to better understand their personal data. It takes the form of an easy-to-use web app that locally processes the raw personal data downloaded from various sources (Twitter, Facebook, Uber, etc) and creates meaningful visualizations.

Setup

  1. Check that you have the correct versions for npm and node (see "engines" in package.json: node 18.x, npm 8.x) by running npm version

  2. In the packages folder, install the root package:

$ cd ../packages
$ npm install
  1. Then, still in the folder packages, build the packages in the monorepo and create symlinks to them. This saves the packages in the global node_modules/ folder (see npm-link documentation).
$ npm run build
$ npm link --workspaces
  1. Navigate back to folder experiences and install the root package. This triggers the postinstall post script that creates symlinks from the previously globally-linked packages to the node_modules/ of the current folder.
$ cd ../experiences
$ npm install
  1. Set up pre-commit hooks:
npm run prepare

  1. Clone hestialabs-bubble-server, and install it as described in its README.md.

  2. to run experiences run npm run dev. This runs the three repos A tab should open in your browser and allow you to run the experiences. To run it without the bubble server and access our production server instead, run API_URL=https://bubbles.hestialabs.org npm run dev:no-local-server.

Instances

The instances are deployed on netlify, where you can see a log of their build. They each point to a different branch of this repo. redirect-to-digipower-academy

Instance test.hestialabs.org digipower.academy experiences.hestialabs.org digipower.hestialabs.org tfac.hestialabs.org
branch netlify-test netlify-academy redirect-to-digipower-academy redirect-to-digipower-academy redirect-to-digipower-academy
netlify name test-experiences digipower.academy hestia-experiences digipower tfac
purpose testing, typically with all features and experiences enabled
config config/config.json config/digipower-academy.json
running it locally npm run dev
status Netlify Status Netlify Status

For developers

# All commands are run in the same folder as this readme
$ cd experiences

Deployment

Update the deployment branch.

# in this example we're deploying to https://digipower.academy
git checkout netlify-academy
git pull
# replace current files with what's in master
git merge -X theirs master

Make sure you have the latest version of all packages

cd ../packages
npm install
npm run build
npm link --workspaces
cd ../data-experience
npm install
npm run build
cd ../experiences
npm install
rm -rf dist

Run the build using the appropriate environment variables.

website build command
test.hestialabs.org BASE_URL=https://test.hestialabs.org API_URL=https://bubbles.hestialabs.org npm run build
digipower.academy CONFIG_NAME=digipower-academy BASE_URL=https://digipower.academy API_URL=https://bubbles.hestialabs.org npm run build

Here's what these variables configure.

Environment variable Description
CONFIG_NAME Name of the configuration file (without extension: "workshop", "digipower" ...)
BASE_URL Url where the website is deployed (with protocol: "https://test.hestialabs.org")
API_URL URL of the rest api (with protocol: "https://bubbles.hestialabs.com")
HESTIA_OWNER_GITHUB_TOKEN Access token that allows using github packages (only needed to configure build done on netlify)

Documentation for the configuration file can be found in config/README.md

# in this example we're building digipower.academy
CONFIG_NAME=digipower-academy BASE_URL=https://digipower.academy API_URL=https://bubbles.hestialabs.org npm run build

Commit and push.

git add dist
git commit -m rebuilt
git push

Netlify then automatically redeploys the website.

Build Setup

The project is built with nuxt. For detailed explanations check out the nuxt documentation. The app follows the default structure of Nuxt, see the docs for more details about the different directories.

To run the dev version, run this script and be patient, this will install all dependencies from sibling projects.

# on windows you can run this in git bash
$ ./dev.sh

If the sibling projects are already installed, you can run the dev version with

npm run dev

Global Configuration

The files in config let us set parameters for each deployment. See the README for more details about the different parameters.

The default is config/config.json (the test deployment), but if you want to use another configuration like config/workshop.json, set the environment variable CONFIG_NAME

# for development
$ CONFIG_NAME=workshop npm run dev
# for production
$ CONFIG_NAME=workshop BASE_URL=https://experiences.hestialabs.org npm run build
# launch server
$ npm run start

Testing

# Run all the tests
$ npm run test

# Run tests interactively
$ npm run test -- --watch

# Update snapshots
$ npm run test -- -u

# Update snapshots interactively
$ npm run test -- -i

(More fine-grained options are available in the docs)

Tests are run with the Jest framework. There are currently three types of tests that can be written.

Unit tests

Unit tests for .js files can be written using Jest. An example is available in utils/csv.test.js.

Component unit tests

Unit tests on components can be written with the help of Jest and Vue test utils. An example is available in components/unit/filterable-table/__tests__/UnitFilterableTable.test.js. It shows how to mount a component, mock the vuex store, and find specific HTML elements.

Please follow the same naming convention: create a __tests__ folder at the same level as the tested component, and name the test file ComponentName.test.js.

Snapshot tests

Snapshot tests can be written to check that the HTML content of a component hasn't changed, by comparing it to a string saved in the __snapshots__ folder. If the changes are intentional, snapshots can be updated with the command above.

An example is available in components/unit/filterable-table/__tests__/UnitFilterableTable.test.js

Note that snapshots do not include Vue props or data, and that child components are not recursively rendered as HTML (e.g. a component BaseButton will appear as an HTML tag <basebutton>).

Upgrading npm on Windows

This is only relevant for Windows users who work with nvm.

We work with a version of npm more recent than the one shipped with the node LTS we are using. There is a standard way of upgrading npm, but it doesn't work with nvm-windows. The way to do it is described in this comment on github:

  • download this as updateNpm.bat file
  • open powershell in that same folder and run this command ./updateNpm.bat latest

Graphs, Plots and Visualisation

Is is possible to dynamically create graphic representation of the data. The can take the form of charts (hystograms, pie charts etc), maps with overlay, etc.

Chart type are defined by files in this directory. The files use the D3 graphics and charts library on top of the Vue framework.

The charts are then available for use in hestialabs experience packages. They are called in blocks.ts files. For instance, the Netflix blocks.ts file calls ChartViewTimeSeries.vue as defined in the file ChartViewTimeSeries.vue.

For debugging purposes, passing option showTable: true displays a text table representation of the data.