homeday-blocks
Advanced tools
A library of Vue components and tokens used across Homeday projects - here
Fork the main repository, clone your fork to your local machine and add the main repo as upstream.
$ git clone git@github.com:YOUR_USERNAME/homeday-blocks.git
$ cd homeday-blocks
$ git remote add upstream git@github.com:homeday-de/homeday-blocks.git
Homeday Blocks requires Node.js version 14.17.0 (.nvmrc). It's recommended to manage multiple versions of Node on the same machine with nvm or nvm-windows.
Don't forget to setup the deeper shell integration in your console to take full advantage of nvm. You can achieve this by adding the following alias into your ~/.bashrc, or ~/.zshrc file:
alias cd="cdnvm(){ cd $1; if [[ -f .nvmrc && -s .nvmrc && -r .nvmrc ]]; then <.nvmrc nvm install; elif [[ $(nvm current) != $(nvm version default) ]]; then nvm use default; fi; };cdnvm"
For a breif explanation of what is being install, please read our setup documentation file.
To install all our dependencies on OSX, run scripts/setup.osx.sh.
To install all our dependencies on Ubuntu, run scripts/setup.ubuntu.sh.
It is recommended to run the setup script everytime you pull from the master branch. This way you can always be sure to have all the project dependencies up to date.
npm run lint
npm run serve:storybook
npm run build:storybook
npm run build
For a brief explanation of how the library is built, checkout this documentation.
To just run all unit tests:
npm run test:unit
To watch for changes while writing tests:
npm run test:unit:watch
To watch for changes while writing tests for a single component:
npm run test:unit:watch ComponentName
Make sure you've PERCY_TOKEN exported first and the project is built.
The token can be obtained from Percy dashboard if you've access to it.
npm run test:percy
You can also follow build statuses in https://percy.io/Homeday/homeday-blocks
tests/ is an alias for <rootDir>/tests/For a basic explanation of what it is and how to use it, please read TYPESCRIPT.md.
We use Hygen as a code generator tool to save time when we need to scaffold some structure.
Just run:
npm run new component
npm run new service
And follow the wizzard in order to generate a base component structure or a service.
This project follows Git Feature Branch Workflow. See project setup to get started locally. That means that all code changes enter the project by PR to master branch. Once you open the PR with suggested changes, the checks for build and coverage will run. If those fail, your PR needs some more work. :)
Each PR should be reviewed by at least two team members. Once reviewed and approved, it can be merged. Please follow the following convention when merging the PR:
It is important to follow this convention, because our automated releases are based on it.
:boom: Removed HdNotNeeded component
:sparkles: Added HdAwesomeComponent
:bug: Fixed that annoying bug
Releasing a new version is as easy as pushing your changes to master 😎
import { HdDynamicForm } from 'homeday-blocks';
Together with the components, Homeday Blocks also provides useful services that can be reused across projects. You can read more about them in the services documentation.
Homeday Blocks has its own infrastructure repository: blocks-infra. Whenever changes need to be made, you can do it in the repository and "deploy". If it is an emergency, you can also use AWS Console but your next step is to update it in the repository to avoid future inconsistencies.
FAQs
A Vue component library built by Homeday's frontend team.
The npm package homeday-blocks receives a total of 89 weekly downloads. As such, homeday-blocks popularity was classified as not popular.
We found that homeday-blocks demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 9 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Critics call the Node.js EOL CVE a misuse of the system, sparking debate over CVE standards and the growing noise in vulnerability databases.
Security News
cURL and Go security teams are publicly rejecting CVSS as flawed for assessing vulnerabilities and are calling for more accurate, context-aware approaches.
Security News
Bun 1.2 enhances its JavaScript runtime with 90% Node.js compatibility, built-in S3 and Postgres support, HTML Imports, and faster, cloud-first performance.