Skip to content

Latest commit

 

History

History
111 lines (71 loc) · 2.44 KB

README.md

File metadata and controls

111 lines (71 loc) · 2.44 KB

Kinetic

Kinetic is an open-source suite of tools that make it easy to build apps that integrate Solana.

It provides a consistent and clean abstraction over the Solana SDKs and enhances it with some commonly requested features like paying Solana fees on behalf of the user, tracking and timing the users transactions and sending out webhooks.

Kinetic is aimed at developers that want to build crypto-experiences for the users of their app, hiding a lot of the details about the blockchain out of sight for both the developer and the end user.

Using Kinetic

See how to use Kinetic in your TypeScript app here.

Or use one of our other SDKs:

Learn more about Kinetic here.

Contributing

If you want to contribute to Kinetic, use the following steps to get started with a local development environment:

Requirements

You need to have the following tools installed on your machine:

  • Node.js 16+
  • Docker 20+
  • Yarn v1.22+

Getting started

git clone [email protected]:kin-labs/kinetic.git
cd kinetic
yarn install

Development setup

Start Services

yarn dev:services

Start the Api

yarn dev:api

Start the Web UI

yarn dev:web

Building the project

You can build the app into a production build:

yarn build

After that, you can run the production app:

yarn start

Testing the project

Use this command to the e2e test of the API:

nx e2e api-e2e

Use this command to the e2e test of the SDK:

nx e2e sdk-e2e

Use this command to run a unit test of one of the projects in the workspace:

nx test api-core-feature

Or in watch mode:

nx test api-core-feature --watch

Run the unit tests on all the projects.

nx run-many --target test --all

What If I Get Stuck?

Pop into the #kinetic-general channel on our Discord, and we'll give you a hand!