Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kin-labs/kinetic
https://github.com/kin-labs/kinetic
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/kin-labs/kinetic
- Owner: kin-labs
- License: mit
- Created: 2022-02-22T19:10:06.000Z (almost 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-02-03T17:48:51.000Z (almost 2 years ago)
- Last Synced: 2024-10-28T22:36:09.310Z (about 1 month ago)
- Language: TypeScript
- Homepage:
- Size: 3.7 MB
- Stars: 40
- Watchers: 4
- Forks: 24
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - kin-labs/kinetic - (TypeScript)
README
# 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](https://developer.kin.org/docs/developers/typescript).
Or use one of our other SDKs:
- [Kinetic Android SDK](https://developer.kin.org/docs/developers/android-kotlin)
- [Kinetic Dart/Flutter SDK](https://developer.kin.org/docs/developers/flutter-dart)
- [Kinetic iOS SDK](https://developer.kin.org/docs/developers/ios-swift)
- [Kinetic Python SDK](https://developer.kin.org/docs/developers/python)
- [Kinetic Unity SDK](https://developer.kin.org/docs/developers/unity)
Learn more about Kinetic [here](https://developer.kin.org/docs/kinetic).
# 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
```shell
git clone [email protected]:kin-labs/kinetic.git
cd kinetic
yarn install
```
## Development setup
Start Services
```shell
yarn dev:services
```
Start the Api
```shell
yarn dev:api
```
Start the Web UI
```shell
yarn dev:web
```
# Building the project
You can build the app into a production build:
```shell
yarn build
```
After that, you can run the production app:
```shell
yarn start
```
# Testing the project
Use this command to the e2e test of the API:
```shell
nx e2e api-e2e
```
Use this command to the e2e test of the SDK:
```shell
nx e2e sdk-e2e
```
Use this command to run a unit test of one of the projects in the workspace:
```shell
nx test api-core-feature
```
Or in watch mode:
```shell
nx test api-core-feature --watch
```
Run the unit tests on all the projects.
```shell
nx run-many --target test --all
```
# What If I Get Stuck?
Pop into the [#kinetic-general](https://discord.com/channels/808859554997469244/973322547854733362) channel on our [Discord](https://kin.org/developerdiscord), and we'll give you a hand!