Giter Club home page Giter Club logo

monorepo's Introduction

PAST3LLE LABS MONOREPO

Packages included:

  1. assets: fonts and svgs common around all Past3lle apps!
  2. components: common layout components, cookie banner, modals
  3. constants: layout sizes, etc.
  4. hooks: common hooks e.g useDetectScrollIntoView, useDebounce and many more
  5. theme: ThemeProvider and general theme components, global styles and theme utils
  6. types: common types
  7. utils: common utils e.g async wait(...) for promisifying and many others
  8. skillforge-widget: skillforge widget component for making PAST3LLE LABS rewards dapps
  9. skillforge-web3: common skillforge related web3 components/providers/hooks/utils
  10. wagmi-connectors: Custom Wagmi connectors until officially released/supported by Wagmi
  11. web3-modal: Extensible Web3 connection modal exposing social login via web3auth and web3modal by default

Apps:

  1. skillforge-ui - the SkillForge skills upgrade UI - get skills and skins from the shop
  2. skills-nft - scripts for uploading metadata and images to IPFS
  3. pastellelabs-landing-ui: PastelleLabs landing page

From other projects: installation example

yarn add @past3lle/components @past3lle/theme @past3lle/utils

Development

Setup

==========
** TIPS **
==========
* It's important to use the Workspace Typescript version. To change this in VSCode, select a TS file and click on the `{}` button inside the footer.
* Only YARN as a package manager is supported.
  1. Install packages and dependencies: yarn
  2. Stream build all packages: yarn build
  3. Test that everything worked: yarn cosmos:scope @past3lle/web3-modal

Testing

==========
** TIPS **
==========
* Monorepo React based packages use React Cosmos for standalone testing/development
* Root package.json comes with syntactic sugar scripts to run stuff, see below
  • To test a package in React Cosmos, use the root script: yarn cosmos:scope <full-package-name> e.g yarn cosmos:scope @past3lle/web3-modal
  • build/serve/cosmos/build:serve/types all have :scope scripts to run individual packages within that script scope.

Committing & PRs

Please use the commit message format:

<package-sub-name>: concise change description

// e.g
web3-modal: enabled multi-chain in config

Please open pull requests with branch names in format:

<your-name>-<sub-module-name>/concise-feature-description

// e.g
steveo-web3-modal/added-multi-chain-config

Issues

Open an issue here and feel free to contribute!

monorepo's People

Contributors

w3stside avatar virgil-pastelle avatar dependabot[bot] avatar github-actions[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.