README.md

Glean Dictionary

The Glean dictionary aims to provide a comprehensive index of datasets generated inside Mozilla for newer applications using the Glean SDK.

This project is under active development and documentation is presently incomplete. For now, please see the project proposal for more details on the Glean Dictionary's ambitions and goals.

You can play with an early version of the Glean Dictionary at:

https://glean-dictionary-dev.netlify.app

Getting Started

You should be able to create your own local copy of the dictionary so long as you have Python (version 3.8) and node.js installed. Follow these instructions:

# Create and activate a python virtual environment.
python3 -m venv venv/
source venv/bin/activate
pip install -r requirements.txt

# Build data needed by dashboard
./scripts/build-glean-metadata.py

# Install npm dependencies and start a local
# instance of the GUI
npm install
npm run dev

If that worked, you should be able to see a local version of Glean at http://localhost:5000

Storybook

We use Storybook for developing and validating Svelte components used throughout the app. To view the existing list of stories, run:

npm run storybook

Storybook Snapshot Testing

To give us more confidence that changes don't unintentionally break the UI, we run storybook snapshot tests.

You can run them manually as follows:

npm run test:jest

If you intentionally made a change to a component that results in a change to the output of the storybook snapshots, you can re-generate them using the following command:

npm run test:jest -- -u

Contributing

For more information on contributing, see CONTRIBUTING.md in the root of this repository.