Git Product home page Git Product logo

swapkit's Introduction

SwapKit

Integrate Blockchains easily

Usage

Documentation

Packages

This repo contains packages around SwapKit sdk and its integrations with different blockchains.

Contributing

Pre-requisites

curl -fsSL https://bun.sh/install | bash
Copy .env.example to .env and fill it with data

Installation

bun bootstrap

Branches

  • main - production branch
  • develop - development branch - all PRs should be merged here first
  • nightly - branch for nightly builds - can be used for testing purposes

Testing

To run tests use bun test command.

Pull requests

  • PRs should be created from develop branch
  • PRs should be reviewed by at least Code Owner (see CODEOWNERS file)
  • PRs should have scope in commit message (see commit messages section)
  • PRs should have tests if it's possible
  • PRs should have changeset file if it's needed (see release section)

New package

To create new package use bun generate and pick one of the options It will setup the package with the necessary files for bundling and publishing.

Release and publish

Packages are automatically published to npm when new PR is merged to main & develop branches. To automate and handle process we use changesets and github action workflows.

Before running bun changeset you have to pull main & develop

To release new version of package you need to create PR with changes and add changeset file to your commit.

bun changeset

After PR is merged to develop branch with changeset file, github action will create new PR with updated versions of packages and changelogs.

swapkit's People

Contributors

0x-general avatar 0xepicode avatar 0xmillz avatar bithighlander avatar blockjayn avatar chillios-dev avatar dependabot[bot] avatar gima-maya avatar github-actions[bot] avatar hey avatar mfaizan1 avatar ochhii1337 avatar olegpetroveth avatar omahs avatar phips28 avatar towantg 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.