Table of Contents

• About the Project
  • Built With
• Getting Started With Contributing
  • Prerequisites
  • Cloning the repositories
  • Starting the dev-environment
• Roadmap
• License
• Contact
• Acknowledgements

About The Project

I find most component frameworks to overly complex and large for most of my needs, so I decided to start publishing encapsulated, small and reusable components that have a clean and easily stylable design.

Built With

The packages all use a template called react-component-publish, and they only ever use eachother as dependencies

Getting Started With Contributing

To get a local test environment up and running follow these simple steps.

Prerequisites

You need to clone both imp-dance/components and imp-dance/components-serve.

• components-serve is your test environment, and essentially a local copy of haakon.underbakke.net/components, where you will be doing most of your work.
• components is where you will add your changes or components and create a pull request.

Cloning the repositories

mkdir hu-components
cd hu-components
git clone https://github.com/imp-dance/components.git

cd ../

mkdir hu-components-test
cd hu-components-test
git clone https://github.com/imp-dance/components-serve.git

Starting the dev-environment

Assuming you are still in ./hu-components-test, run the follwing commands

cd components-serve/components
npm install

After the packages have finished installing, you can start the test environment

npm run start

Making changes

From components-serve/components, you can load in the examples from src/components/reusable instead of directly from NPM, then you can edit them directly to see the live changes.

Roadmap

See the open issues for a list of proposed features (and known issues).

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Håkon Svennes Underbakke - @impedansen - [email protected]

Project Link: https://github.com/imp-dance/components

Acknowledgements

• react-component-publish