Skip to content

Commit a290a99

Browse files
committed
Design updates
1 parent 5f6b46a commit a290a99

File tree

6 files changed

+86
-48
lines changed

6 files changed

+86
-48
lines changed

README.md

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,51 @@
1-
> The framework is a collection of tools and principles used to make creating pattern libraries fun for developers, transparent for teams, and sustainable beyond the lifecycle of digital products.
1+
<blockquote class="mb-8"><p>The framework is a collection of tools and principles used to make creating pattern libraries fun for developers, transparent for teams, and sustainable beyond the lifecycle of digital products.</p></blockquote>
22

3-
### Why Patterns?
3+
<!-- > The framework is a collection of tools and principles used to make creating pattern libraries fun for developers, transparent for teams, and sustainable beyond the lifecycle of digital products. -->
44

5-
**Pattern libraries unify the experience of user interfaces because they can be integrated into different service delivery channels**. The public does not perceive the parts that make up digital government services as distinct products the way civil servants do. Websites, forms, mobile apps, dashboards, email newsletters, etc. are often perceived as a single entity. The more consistent these are from a user interface (UI) and user experience (UX) perspective the better the service delivery will be for end-users.
5+
## Why Patterns?
66

7-
**They reduce the amount of work that is required by designers and developers to implement new services**. By using patterns we can strive toward "making the right thing to do the easiest thing to do." We can use tools that help developers become better at writing error free code, ensure the team adheres to accessibility standards, and create UIs that have been proven to work **and** can adapt to the changing times.
7+
<div class="shadow-up"><div class="color-primary-background border-navy p-4 h4 mb-3">
88

9-
**They create a common and accessible language for the organization to approach digital service delivery**. "Language is fundamental to collaboration. If you work in a team, your design language needs to be shared among the people involved in the creation of the product. Without a shared language, a group of people can't create effectively together – each person will have a different mental model of what they're trying to achieve." - [**Design Systems**](https://www.smashingmagazine.com/design-systems-book/) by Alla Kholmatova.
9+
**Pattern libraries unify the experience of user interfaces because they can be integrated into different service delivery channels.**
1010

11-
### Principles
11+
</div></div>
1212

13-
[Atomic Design](https://atomicdesign.bradfrost.com/) and [Utility-first](https://tailwindcss.com/docs/utility-first) - A pattern library starts with simple [design tokens](https://www.lightningdesignsystem.com/design-tokens/) such as color, typographic features, and spacing values then scales up from there. Design tokens are used to build out more complex components, scripts, and utilities that retain modularity.
13+
The public does not perceive the parts that make up digital government services as distinct products the way civil servants do. Websites, forms, mobile apps, dashboards, email newsletters, etc. are often perceived as a single entity. The more consistent these are from a user interface (UI) and user experience (UX) perspective the better the service delivery will be for end-users.
14+
15+
<div class="shadow-up"><div class="color-primary-background border-navy p-4 h4 mb-3 mt-6">
16+
17+
**They reduce the amount of work that is required by designers and developers to implement new services**.
18+
19+
</div></div>
20+
21+
By using patterns we can strive toward "making the right thing to do the easiest thing to do." We can use tools that help developers become better at writing error free code, ensure the team adheres to accessibility standards, and create UIs that have been proven to work **and** can adapt to the changing times.
22+
23+
<div class="shadow-up"><div class="color-primary-background border-navy p-4 h4 mb-3 mt-6">
24+
25+
**They create a common and accessible language for the organization to approach digital service delivery**.
26+
27+
</div></div>
28+
29+
"Language is fundamental to collaboration. If you work in a team, your design language needs to be shared among the people involved in the creation of the product. Without a shared language, a group of people can't create effectively together – each person will have a different mental model of what they're trying to achieve." - [**Design Systems**](https://www.smashingmagazine.com/design-systems-book) *by Alla Kholmatova*.
30+
31+
## Principles
32+
33+
**[Atomic Design](https://atomicdesign.bradfrost.com/) and [Utility-first](https://tailwindcss.com/docs/utility-first)** - A pattern library starts with simple [design tokens](https://www.lightningdesignsystem.com/design-tokens/) such as color, typographic features, and spacing values then scales up from there. Design tokens are used to build out more complex components, scripts, and utilities that retain modularity.
1434

1535
**Framework Agnostic** - Use [React](https://reactjs.org), [Svelte](https://svelte.dev), or [Vue.js](https://vuejs.org) to add reactivity to user interface components. Manage your own copy of [Bootstrap](https://getbootstrap.com), [Material UI](https://mui.com), [Foundation](https://get.foundation/), or any of the many component libraries of choice.
1636

1737
**Modular Distribution and Portability** - Make it once, use it many times. Instead of copying and pasting CSS and JavaScript into multiple projects, reuse and extend pattern libraries with a modern front-end ecosystem such as [NPM](https://www.npmjs.com) and distribute via content-delivery-network.
1838

19-
### Getting Started
39+
## Getting Started
2040

2141
Scaffold your own library or project by running the following command.
2242

2343
```shell
24-
pre npx @nycopportunity/pttrn scaffold && npm install && NODE_ENV=development pttrn && npm start
44+
npx @nycopportunity/pttrn scaffold && npm install && NODE_ENV=development pttrn && npm start
2545
```
2646

2747
This will install the [Patterns Command Line Interface](https://github.com/cityofnewyork/patterns-cli) described below, scaffold a new static library project, and start the development server.
2848

29-
#### But I don't write code!
49+
### But I don't write code!
3050

3151
No worries! Then perhaps try documenting your pattern library specs in a [Figma](https://www.figma.com/design-systems/) design file first and share this with your development team.
32-
33-
<!-- The [Mayor's Office for Economic Opportunity](http://nyc.gov/opportunity) (NYC Opportunity) supports and promotes open-source software development. This repository contains our open–source policy and a list of public repositories on GitHub, including public-facing digital products and packages used by our products. Feel free to ask questions and share feedback. **Interested in contributing?** See our open positions on [buildwithnyc.github.io](http://buildwithnyc.github.io/). For details on maintaining this site refer to the [contributing guide](https://github.com/NYCOpportunity/loves-open-source/blob/main/contributing.md). -->

dist/img/open-graph.png

-18.6 KB
Loading

0 commit comments

Comments
 (0)