Heima

A cozy open-source front-end library.

Getting Started

There are currently two ways to install Heima.

Installing Using npm:

Inside your project directory run:

  npm install heima

Downloading or Cloning the Git Repository:

Download the zip file for Heima by clicking the green Clone or download button followed by Download ZIP.

Clone Heima by entering the following command into your terminal.

  git clone https://github.com/kristenmarie/kristenkulha.com.git 

Documentation

Get the low-down on using Heima by visiting our docs.

Contributing

Anyone is more than welcome to contribute to Heima, and that includes you! Yes, YOU! If you are a seasoned open source contributor, you know the ropes. However, if you're new to this whole thing here are some steps to get you going (and don't be shy, any contribution is welcome!):

1. Fork this project by hitting the Fork button at the top right of this project page. It looks like this:
2. Clone it so you have it locally (i.e. get it on your computer!).
3. Run Heima on your machine. First, navigate to the project directory:

     cd heima

   From there, build and run heima be entering the following command:

     npm run start

   Then navigate to http://localhost:8080/. This is where you can see all the components we have so far.
4. Make a feature branch for your contribution.
5. Build all the things! Noticed that something is broken? Fix some bugs! Just don't forget to write clear commit messages that convey what you have done.
6. Push your branch to your origin.
7. Create a pull request:
   • Navigate to your fork of Heima and you'll see a new green button next to your feature branch at the top of the repository. Click it!
   • You'll come to a form for your pull request. Enter a title and description of what you have built. Then hit the green create pull request button.
   • Success! You have made a contribution and we think you're flippin' awesome. High-fives all around.
8. Your work is done for now, and the folks who maintain the repository will take a look at your handiwork. We may provide some code review feedback, so keep your eyes peeled.

License

Copyright 2019 Kristen Kulha and William Kulha

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.