Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 2 KB

README.md

File metadata and controls

42 lines (26 loc) · 2 KB
Raw

Blocks

Libraries for building custom storefronts with BRIKL

Developing

Please make sure you have the following prerequisites:

  • A desktop platform with the LTS version of NodeJS installed.
  • You have yarn installed in your machine
  • When working with the codebase, we recommend using an IDE with intelligent code completion and syntax highlighting, such as Visual Studio Code or WebStorm.

Downloading the source code

Clone the repository:

git clone https://github.com/brikl/blocks
cd blocks

To update the source code to the latest commit, run the following command inside the blocks directory:

git pull

Developing

We are focusing on keeping every applications and libraries to be type-strict as much as possible, so every file must be written in TypeScript as much as possible.

Contributing

When it comes to contributing to the project, the two main things you can do to help out are reporting issues and submitting pull requests. Based on past experiences, we have prepared a list of contributing guidelines that should hopefully ease you into our collaboration process and answer the most frequently-asked questions.

Note that while we already have certain standards in place, nothing is set in stone. If you have an issue with the way code is structured, with any libraries we are using, or with any processes involved with contributing, please bring it up. We welcome all feedback so we can make contributing to this project as painless as possible.

Licence

All libraries under this repository are licensed under the MIT licence. Please see the licence file for more information. tl;dr you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source.