https://github.com/digitalinteraction/alembic

⚗️ Design toolkit for research projects
https://github.com/digitalinteraction/alembic

design-system eleventy github-pages openlab-alembic

Last synced: about 2 months ago
JSON representation

⚗️ Design toolkit for research projects

• Host: GitHub
• URL: https://github.com/digitalinteraction/alembic
• Owner: digitalinteraction
• Created: 2022-02-23T22:56:44.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-11T11:01:43.000Z (3 months ago)
• Last Synced: 2024-11-11T11:45:08.043Z (3 months ago)
• Topics: design-system, eleventy, github-pages, openlab-alembic
• Language: TypeScript
• Homepage: https://alembic.openlab.dev
• Size: 1.35 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# ⚗️ Alembic

A Design System for Open Lab research projects.

[**Go to the docs →**](https://digitalinteraction.github.io/alembic/)

## Release process

1. Run the build

2. Update API docs if needed

3. Run `npm version minor|major|patch`

4. Run `npm publish`

## Uses

This library is used by several Open Lab projects:

- [openlab.ncl.ac.uk](https://openlab.ncl.ac.uk) - [repo](http://github.com/digitalinteraction/openlab.ncl.ac.uk)

- [datadiaries.uk](https://datadiaries.uk) - [repo](https://github.com/digitalinteraction/datadiaries-app)

- [alembic.openlab.dev](https://alembic.openlab.dev) - (this repo)

- [Coffee Club](https://github.com/digitalinteraction/beancounter)

## Design

**Goals**

1. Provide a step up (design-wise) for developers

2. Reduce duplication in effort/code/work

3. Improve collaboration on projects and focus evolution in the same direction

**What**

- A library of components and patterns

- A documentation site to describe the design system

**To explore**

- More accessibility concerns

- Document the reason behind decisions / solutions

- Think about adaptability, evolution and collaboration

## Coding conventions

> TODO: find a better place for these

**css variables**

- "axioms" are single words like `--measure`

- everything else is type-prefixed like `--color-background` or `--border-thin`

**imports**

`module.js` is the main entrypoint, sub-modules are self-named files in their own folder e.g. `lib/lib.js` or `layouts/layouts.js`.

**misc**

- group source by the module, js + css alongside eachother is fine. It makes it easy to work on a module.

- avoid JavaScript's default exports

- sub-modules should explicitly export things, avoid `export * from '...'`-type code

- pure functions where possible

- exported code prefixed with `_` (an underscore) is internal, should not be used and may change between major releases

---

> This project was set up by [puggle](https://npm.im/puggle)