Blocks UI Protocol: Decentralized UI Software as an NFT

🌎 💽 🤑

Decentralized. UI Software. As NFTs.

Providing an open and decentralized framework for building user interface software that is simple enough for anyone to use.

Table of Contents

• Moralis + Filecoin 1-2-Web3 Hackathon
  • Use of hackathon tech
• Contributing
  • Types
  • Branches
  • Commits
  • Pull Requests
  • Merging Into Main

Moralis + Filecoin 1-2-Web3 Hackathon.

This project is the entry to the Moralis x Filecoin hackathon from the CRCLS team. It consists of five repositories:

• Blocks UI App
• Blocks UI Blocks
• Blocks UI Contracts
• Blocks UI Network
• Blocks UI SDK

Use of hackathon tech

1. scripts/upload.mjs - Used in the GitHub actions deploy CI to upload the compiled Block Primitives to Web3.Storage

Contributing

Code changes can fall into the types from the Conventional Commits specification.

Types

Common types according to commitlint-config-conventional (based on the Angular convention) can be:

• build—changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm).

• chore—other changes that don’t modify src or test files.

• ci—changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs).

• docs—documentation only changes.

• feat—a new feature.

• fix—a bug fix.

• perf—a code change that improves performance.

• refactor—a code change that neither fixes a bug nor adds a feature.

• revert—reverts a previous commit.

• style—changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).

• test—adding missing tests or correcting existing tests.

Branches

Branches are created from main and can follow the naming convention below. For common types, see Types.

Convention:

type/description

Example:

feat/add-xyz

Commits

Conventional Commits are enforced using commitlint in a husky pre-commit hook.

Convention:

type(scope?): description  #scope is optional; multiple scopes are supported (current delimiter options: "/", "\" and ",")

Example:

feat: add xyz

Pull Requests

1. Title

   Titles can follow the naming convention below and match the branch name. For common types, see Types.

   Convention:

   type: description

   Example:

   feat: add xyz

2. Body

   When creating a new pull request, you will automatically see a template with a checklist in the body.

3. Reviewers

   Add at least one reviewer.

4. Labels

   Apply related labels.

Merging Into Main

Always “Squash & merge” your commits into main.