wn-fm-dreae v0.0.45

Facility Manager

Facility Manager is a component library that exports several react components. These components are used to display and modify floor plans in seedit application.

• High-level exports that are able to show floor plans in different contexts (i.e. in booking, reports etc)
• Low-level exports that can be used to compose a customized floor plan view (i.e. FMContainer)

Usage

The purpose of this package is to export several components. Therefore, the development environment is based on storybook.

Development

1. Clone and enter directory

git clone https://git.rle.de/workplace-booking/facility-manager.git
cd facility-manager

2. Install dependencies

npm install

Note: This package requires a peer-dependency of react 16.8 or higher.

3. Launch storybook.

npm run storybook

Versioning

To contribute and make commits, you must comply with the conventional commit specification. ALL breaking changes must be explicitely declared in your commit. Otherwise your change will be released as a patch and packages that depend on this project may break when npm automatically updates their dependency.

Currently the dist-tags @latest and @next are used.

Using in a Project

Before we can install the library, we have to set-up npm to authenticate to the git.rle.de registry.

Once this is done, we can install the package as a dependency.

npm install @workplace-booking/facility-manager

Once successfully installed, we can import components as usual.

import { FMContainer } from "@workplace-booking/facility-manager";

For a list of exported components, refer to documentation.

Sym linking

For developing this package, it may be useful to sym-link to your project.

When inside this project, first we run the link command, and then we build the package in watch mode, so that our changes are built automatically.

cd facility-manager
npm link
npm run build:watch

Then, in your other project, use the link.

cd <another project>
npm link @workplace-booking/facility-manager

All rights reserved.