Skip to content

Commit

Permalink
fix: update the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@melniiv
melniiv committed Nov 11, 2024
1 parent 9881925 commit 4f0c142
Showing 1 changed file with 125 additions and 82 deletions.
207 changes: 125 additions & 82 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,103 +1,64 @@
# React Helsinki Headless CMS

Demo:
## Introduction

## Quick Start
React Helsinki Headless CMS - is a highly customized component library based on [HDS](https://github.com/City-of-Helsinki/helsinki-design-system). It is designed for Helsinki City Web applications which are using preconfigured Wordpress Headless CMS environments (compatible with the library). This library is a set of unified visual components for Pages, Artciles, Artcicle Archives which provide:

1. Unified designs for pages, layouts, and custom components across multiple applications.
2. Ability to pass app-specific configurations, such as translations and themes.
3. A set of components for visually presenting data from WordPress content modules and features.
4. A set of utilities, type and constants required for components implementation.
5. Support for required Apollo providers, such as linked events and venue search.

**Note:** This library does not inject the Helsinki Grotesk font for you--you must add it yourself.

**Note:** This library uses HDS design tokens through the SCSS interface so that mitch matching design token versions does not lead to unexpected results.

### 1. Install

```bash
yarn add react-helsinki-headless-cms
```

### 2. Import

`App.tsx`
### The known clients that are using this library

```tsx
// ...
import {
Page,
PageContent,
ConfigProvider,
defaultConfig,
} from "react-helsinki-headless-cms";
- The city of Helsinki Events: https://tapahtumat.hel.fi | https://github.com/City-of-Helsinki/events-helsinki-monorepo
- The city of Helsinki Hobbies: https://harrastukset.hel.fi | https://github.com/City-of-Helsinki/events-helsinki-monorepo
- The city of Helsinki Sports: https://liikunta.hel.fi | https://github.com/City-of-Helsinki/events-helsinki-monorepo
- The city of Helsinki Kultus: https://kultus.fi | https://github.com/City-of-Helsinki/palvelutarjotin-ui
- The city of Helsinki Culture Kids: https://kummilapset.hel.fi/ | https://github.com/City-of-Helsinki/kukkuu-ui

function App() {
const page = ...;
## Installation

return (
<ConfigProvider config={defaultConfig}>
<Page
navigation={
<Navigation
languages={...}
menu={...}
onTitleClick={() => ...}
getUrlForLanguage={(language, currentLanguage) => new URL(...)
}
/>
}
content={<PageContent page={page} breadcrumbs={[...]} />}
footer={...}
/>
</ConfigProvider>
);
}
```bash
yarn add react-helsinki-headless-cms
```

## Use provided queries
## Development

This can handle data queries for you if you are using a supported library to fetch your data.
**NOTE: The library is for general use and should not be developed for a single application environment only!** Check [the known clients](#the-known-clients-that-are-using-this-library)

### Apollo
### When to develop

By importing data dependent components from `react-helsinki-headless-cms/apollo`, this library will request the data for you.
The general requirements for new Component development:

**Note:** An Apollo client linked to a graphql endpoint with a supported schema (headless CMS) must be provided in the `apolloClient` field of the `config` object.
1. The new Component must be connected to an instance of the WordPress Headless CMS.
2. The Wordpress Headless CMS environment has new Component compatible architecture, features and data structure (component library is heavily dependent on the GraphQL schemas).
3. The new Component is not presented in [HDS](https://github.com/City-of-Helsinki/helsinki-design-system) or HDS cannot fully fulfill the specifications.
4. The new Component exists in HDS backlog, however, still it is not released by HDS team. In that case, HCRC new Component can be implemented and later must be replaced with HDS component when one is available.
5. New Component can be reused accross multiple applications.

**Simplified example**
### Available scripts

```tsx
import { Page } from 'react-helsinki-headless-cms/apollo';
import { Navigation } from 'react-helsinki-headless-cms/apollo';

<ConfigProvider
config={{
// ...
apolloClient: client, // A client for the CMS
eventsApolloClient: client, // A client to connect a events datasource (the LinkedEvents)
venuesApolloClient: 'disabled', // A client to connect a venue datasource (the Servicemap / "TPREK")
// ...
}}
>
<Page
uri="/en/url"
navigation={<Navigation menuName="Name of menu in headless CMS" />}
/>
</ConfigProvider>;
```

### NextJS

We provide utilities for fetching headless data for NextJs in `react-helsinki-headless-cms/nextjs`. These can be used when generating static pages.

## For Developers of Library

**NOTE: The library is for general use and should not be developed for a single application environment only!** Check [the known clients](#the-known-clients-that-are-using-this-library)

| Name | Purpose | Useful Options |
| --------------------- | -------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
| `yarn dev` | Starts storybook environment that can be used for developing components. | |
| `yarn typecheck` | Runs the ts type check in the project components. | |
| `yarn lint` | Lints the application to be according to quality standards (eslint) and formatting standards (prettier). | `--fix`: fix fixable problems |
| `yarn test` | Runs tests with jest. | `--watch`: enable watch mode |
| `yarn test-storybook` | Runs storybook accessibility tests jest. | |
| `yarn build` | Builds application with rollup. | |
| `yarn docker:dev` | Runs the application with docker with Development target environment. | |
| `yarn docker:prod` | Runs the application with docker with Production target environment. | |
| `yarn docker:down` | Shuts down the docker environment. | |
| `yarn publish-canary` | Publishes a canary tagged version of the application. CD is configured to run this script on additions to the main branch. | |
| `yarn publish-stable` | Publishes a stable tagged version of the application. CD is configured to run this script on additions to the main branch. | |
| `yarn generate:graphql` | Generates / updates GraphQL schema for the project. | |

**NOTE: To manually publish a new version to the NPM, you will need the credentials that can be found from the City of Helsinki Culture and Leisure's Vault-service.**

Expand All @@ -107,7 +68,7 @@ This library consists of three modules.

- Core module that includes data naive components.
- Apollo module that wraps core module components with logic that is able to fetch data with the help of an `ApolloClient` instance.
- Nextjs module that provides utilities when working with Nextjs and Apollo.
- Nextjs module that provides utilities when working with `Nextjs` and `Apollo`.

### CI

Expand All @@ -116,6 +77,7 @@ Checks
- Tests pass
- Lint pass
- Build completes
- Type check pass

### CD

Expand All @@ -127,8 +89,46 @@ On a new release, a new version is released to npm.

Storybook is a frontend workshop for building UI components and pages in isolation https://storybook.js.org/. The Storybook can be used to develop and to test the components, but also to document the components and their features.

The project is using the Storybook 8.

**NOTE: Storybook version 8 may require the `playwright-chromium` installation.**

The `yarn dev` command will start `storybook` in port `6006`. When you make changes in `src`, they'll be automatically updated to `storybook`.

### Apollo

This can handle data queries for you if you are using a supported library to fetch your data.

By importing data dependent components from `react-helsinki-headless-cms/apollo`, this library will request the data for you.

**Note:** An Apollo client linked to a graphql endpoint with a supported schema (headless CMS) must be provided in the `apolloClient` field of the `config` object.

**Simplified example**

```tsx
import { Page } from 'react-helsinki-headless-cms/apollo';
import { Navigation } from 'react-helsinki-headless-cms/apollo';

<ConfigProvider
config={{
// ...
apolloClient: client, // A client for the CMS
eventsApolloClient: client, // A client to connect a events datasource (the LinkedEvents)
venuesApolloClient: 'disabled', // A client to connect a venue datasource (the Servicemap / "TPREK")
// ...
}}
>
<Page
uri="/en/url"
navigation={<Navigation menuName="Name of menu in headless CMS" />}
/>
</ConfigProvider>;
```

### NextJS

We provide utilities for fetching headless data for NextJs in `react-helsinki-headless-cms/nextjs`. These can be used when generating static pages.

### Use as a application dependency

The easiest way to test the React Helsinki Headless CMS -library is to install it as a dependency of an application by using a local relative path: https://docs.npmjs.com/cli/v9/configuring-npm/package-json#local-paths.
Expand Down Expand Up @@ -158,16 +158,59 @@ This project uses `rollup` for its final bundle.

A new version of the `npm` package is automatically released when a new release is created in GitHub. Additionally, a new canary release is created after each new push into master.

### Known issues
## Testing

With new features introduced in Storybook version 7, this library is configured with `@storybook/addon-a11y` Axe Accessibility Plugin.

The test could be run from the Storybook UI (Accessibility tab of the Story) or using the script.

### Testing in IDE terminal

```bash
yarn test-storybook
```

After executing the script, you will get the Axe Accessibility testing report in the terminal window.
The number of tests are dynamic per component and decided by Axe plugin logic.

## Usage

`App.tsx`

```tsx
// ...
import {
Page,
PageContent,
ConfigProvider,
defaultConfig,
} from "react-helsinki-headless-cms";

function App() {
const page = ...;

return (
<ConfigProvider config={defaultConfig}>
<Page
navigation={
<Navigation
languages={...}
menu={...}
onTitleClick={() => ...}
getUrlForLanguage={(language, currentLanguage) => new URL(...)
}
/>
}
content={<PageContent page={page} breadcrumbs={[...]} />}
footer={...}
/>
</ConfigProvider>
);
}
```

## Known issues

- Jest has difficulties loading this library. When this library is required in a test file, it's possible that some imports are cjs and some are esm. These two variants do not share a react context which can result in `useConfig` calls that return an empty config object even though `<ConfigProvider>` is declared correctly. I.e. `<ConfigProvider>` sets values for `context1` and `useConfig` reads `context2`.
- `yarn generate:graphql` does not work with Node.js v16 or greater
- Some of the built packages created with `yarn build` does some issues with some types. This leads to a situation where the application that uses the library cannot read all the exported types. Especially the exported enums inside a built package might be handled incorrectly (https://github.com/rollup/rollup/issues/4291), but there are other type related issues also, but not on every built package.

### The known clients that are using this library

- The city of Helsinki Events: https://tapahtumat.hel.fi | https://github.com/City-of-Helsinki/events-helsinki-monorepo
- The city of Helsinki Hobbies: https://harrastukset.hel.fi | https://github.com/City-of-Helsinki/events-helsinki-monorepo
- The city of Helsinki Sports: https://liikunta.hel.fi | https://github.com/City-of-Helsinki/events-helsinki-monorepo
- The city of Helsinki Kultus: https://kultus.fi | https://github.com/City-of-Helsinki/palvelutarjotin-ui
- The city of Helsinki Culture Kids: https://kummilapset.hel.fi/ | https://github.com/City-of-Helsinki/kukkuu-ui

0 comments on commit 4f0c142

Please sign in to comment.