knotel / website-ui

The UI repository for the new knotel-website UI

knotel-website-ui

Made with create-react-library

Install

npm install --save knotel-website-ui

Usage

import React, { Component } from "react";

import MyComponent from "knotel-website-ui";
import "knotel-website-ui/dist/index.css";

class Example extends Component {
  render() {
    return <MyComponent />;
  }
}

Package

1. check the package.json to see what the version is
2. update package.json's version to the next version e.g. 1.4.15 -> 1.4.16 (this is very important--otherwise it gets detected as the same NPM module version)
3. from the root dir run yarn run build
4. manually crete a folder called "package" and copy/paste the package.json, readme.md, and dist folder into it
5. from the root dir, run: tar -cvzf knotel-website-ui-v1.4.16.tgz package/
6. publish
7. update new-website with new reference
8. fin

Autopackage

1. update package.json to new verison
2. (if never done before): invoke in bash the following to enable execution of the script chmod +x maketar.sh
3. invoke in bash: ./maketar.sh 1.6.4 where the version matches the package.json version
4. commit the files and push
5. if this is a production release, create a new tag and include that

License

MIT ©

Salesforce integration

The salesforce team (Dheeconsulting) will provide a form element. Convert the form in src/components/ContactForm/index.js to match the form components. Do not just copy paste the form in. you will get an unstyled form.

website-ui's Issues

the website-ui and new-website should be combined into a single repository

Having them split apart hampers developer throughput