Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/apillon/sdk

apillon cli sdk typescript

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/apillon/sdk
Owner: Apillon
License: mit
Created: 2023-03-08T11:10:27.000Z (almost 2 years ago)
Default Branch: master
Last Pushed: 2024-10-29T10:20:04.000Z (about 2 months ago)
Last Synced: 2024-11-02T13:04:55.495Z (about 2 months ago)
Topics: apillon, cli, sdk, typescript
Language: TypeScript
Size: 1.08 MB
Stars: 3
Watchers: 2
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Apillon Web3 Development tools

[![Twitter Follow](https://img.shields.io/twitter/follow/Apillon?style=social)](https://twitter.com/intent/follow?screen_name=Apillon)

Welcome to the Apillon Web3 Development Platform! This repository contains the source code for both the CLI and SDK libraries for the platform.

## Overview

The Apillon Web3 Development tools is an open-source toolset that makes it easy to build and deploy decentralized applications on the blockchain. It includes a command-line interface (CLI) for managing your projects, as well as a software development kit (SDK) for integrating with the Apillon APIs.

## Installation

To get started with the Apillon Web3 Development Platform, you can install either the CLI or SDK libraries. Here's how:

### CLI

[![npm version](https://badge.fury.io/js/@apillon%2Fcli.svg)](https://badge.fury.io/js/@apillon%2Fcli)

To install the CLI, run the following command:

```sh
npm install -g @apillon/cli
```

### SDK

[![npm version](https://badge.fury.io/js/@apillon%2Fsdk.svg)](https://badge.fury.io/js/@apillon%2Fsdk)

To install the SDK, run the following command:

```sh
npm install @apillon/sdk
```

## Usage

Please see [CLI Documentation](/packages/cli/README.md) and [SDK Documentation](/packages/sdk/README.md) for more information.

Find more resources at [wiki.apillon.io](https://wiki.apillon.io).

## Contributing

We welcome contributions to the Apillon Web3 Development Platform! If you would like to contribute, please follow these steps:

1. Fork this repository.
2. Clone your forked repository to your local machine.
3. Install the dependencies by running npm install.
4. Make your changes and write tests to ensure they work.
5. Commit your changes and push them to your forked repository.
6. Open a pull request to this repository.

Before submitting a pull request, please make sure to run the tests by running npm test. We also recommend running npm run lint to ensure your code follows our coding standards.

## License

This project is licensed under the MIT License - see the [LICENSE](/LICENSE) file for details.