Build in Blocks [Framework]

SOFTWARE ENGINEERING CONTRIBUTING DOC FOR BUILD IN BLOCKS FRAMEWORK

General Information about project

Build in Blocks [Framework]COLLABOCATE'S BUILD IN BLOCKS FRAMEWORK PROJECT

Local development instructions

We've made recent changes to the repository location and local development instructions of this project. Therefore, this section may be outdated. For now and pending the time that this section will be updated, you can get guidance on where to find and how to run this project in our collabo community Discord channel.

Head over to the GitHub repository: https://github.com/collabo-community/building-blocks
Fork and clone the repository as shown in the SWE contribution workflow.

Find the local development instructions for the different Building Blocks projects in the tabs below, depending on the one you want to develop locally.

Once you have the repository on your local computer, ensure you are in the root of the project's directory. Then follow the steps below.

Installing project dependencies

Install dependencies (if you have not done so before):

npm install

Run and watch changes for Block CSS files

Run the script command below to compile/build the scss files into css files:

npm run blocks:css

Once you have the repository on your local computer, ensure you are in the root of the project's directory. Then follow the steps below.

Installing project dependencies

Install dependencies (if you have not done so before):

npm install

Generating Blocks TS build files:

Run the script command below to compile/build the typescript files into .js and .d.ts files:

npm run blocks:ts:build

Testing out Blocks TS in other Collabo Community projects

The BlocksTS library only works in projects using NodeJS environment i.e. it only works in projects where node_modules folder is generated based on the dependencies/content of the package.json file.

Follow these steps when developing and testing out the changes made to the Blocks TS library, in some other Collabo Community project:

First steps:

Ensure you have both the building building blocks repo and the repo for the project you want to test locally on your computer.
Ensure that you have also followed the local development instructions to install dependencies, set them up and you are able to run them without problems.

Change directory into the project you want to use to test the BlocksTS library in. Then do the following:

Link your local building blocks repo, using the relative path to your local building blocks repo. For example, if the repo folder for project you are testing with and the building blocks repo folder are on the same level and share the same parent folder, you would link it like so:

npm link ../building-blocks

Then add the building blocks package to the project's dependencies as shown below. Check the package.json of the building blocks repo to know the version of the package to use. For example, if building blocks' package.json has "version": "0.0.0" , you would add it to the package.json dependencies for the project you are testing with like so:

"@collabo-community/building-blocks": "^0.0.0"

Import what you need from building blocks, and start using/testing in the project.

PreviousCollabocate [Website]NextBuild in Blocks [Assistant]

Last updated 3 months ago

Was this helpful?