Skip to content

nickjohngray/blockout

Repository files navigation

                                                                                                                                                                                                             
  ______  _      _____  _____  _   __  _____  _   _  _____ 
  | ___ \| |    |  _  |/  __ \| | / / |  _  || | | ||_   _|
  | |_/ /| |    | | | || /  \/| |/ /  | | | || | | |  | |  
  | ___ \| |    | | | || |    |    \  | | | || | | |  | |  
  | |_/ /| |____\ \_/ /| \__/\| |\  \ \ \_/ /| |_| |  | |  
  \____/ \_____/ \___/  \____/\_| \_/  \___/  \___/   \_/                                                             
              Building Blocks that REACT outside the box                                               

######BlockOut is a React Component Library that makes styling grate again By styles, I mean css styles, in the pass I have worked with many other React component libraries and I have found very difficult to style and use. I'll update this readme after adding each componet. I know there is just a Toggler Component right now, but all this is going to change when BlockOut makes coding grate again.

Contact me nickjohngray@gmail.com for help.

Scripts

prepublishOnly : npm test && npm run lint

prepublishOnly will run BEFORE prepare and ONLY on npm publish. It will run the test and lint to make sure it doesn't publish bad code.

bump

npm version patch npm run bump, bumps a new version, triggers preversion version postversion in this order ensure git status is clean and the code is commied before running

preversion

npm run lint - preversion

runs before bumping a new package version. To be 100% sure a new version with bad code does not get published.

version

npm run format && git add -A src

Runs after a new version is bumped.

commits a new version-tag every time a new version is bumped. This command will run BEFORE the commit is made. A formatter could be run at this stage so no ugly code will pass into the new version:

postversion:

git push && git push --tags

Runs after the commit has been made. A perfect place for pushing the commit as well as the tag.

npm version patch

Bump a new patch version of the package The preversion, version, and postversion will run and create a new tag in git and push it to the remote repository.

npm upload

npm push will run npm deploy, if eveything is good ( tslint and tests pass) a new version is deployed.

npn test

Runs all tests

Tips

Ignore tracked files from git that were accidentally committed

git rm -r --cached .

git add .

git commit -m ".gitignore fix"

#Componets

##Tree

the tree componet builds this html structure from a json object

 
  • Beverages
    • Water
    • Coffee
    • Tea
      • Black Tea
      • White Tea
      • Green Tea
        • Sencha
        • Gyokuro
        • Matcha
        • Pi Lo Chun