Introduction #

What is Elements? #

Elements is our default library for web-based applications at christmann informationstechnik + medien GmbH & Co. KG. It consists of several packages under the namespace @cim-elements/*.

Getting started #

Yarn #

You need to have yarn installed.

npm install --global yarn

GitLab access token #

You need an access token to christmann's GitLab server at https://gitlab.christmann.info. The access token needs to have read access to the api and it should be available under the environment variable GITLAB_API_READ_ACCESS_TOKEN. This can be done by adding it to your .bashrc file in your user home directory (under Linux).

# .bashrc
export GITLAB_API_READ_ACCESS_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Font Awesome token #

Our projects use font awesome icons. To access the pro icons you need to provide the token for access:

# .bashrc
export FONTAWESOME_NPM_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Start a new project #

To start a new elements project you can run the cli command cim.

cim