Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jcam1/sdks
Monorepo for JPYC Node SDKs
https://github.com/jcam1/sdks
astar avalanche ethereum gnosis hardhat japanese jpy jpyc node-js npm-package polygon sdk stablecoin typescript viem
Last synced: 7 days ago
JSON representation
Monorepo for JPYC Node SDKs
- Host: GitHub
- URL: https://github.com/jcam1/sdks
- Owner: jcam1
- License: mit
- Created: 2024-07-02T08:28:59.000Z (5 months ago)
- Default Branch: develop
- Last Pushed: 2024-08-29T06:59:55.000Z (3 months ago)
- Last Synced: 2024-11-07T05:46:07.795Z (13 days ago)
- Topics: astar, avalanche, ethereum, gnosis, hardhat, japanese, jpy, jpyc, node-js, npm-package, polygon, sdk, stablecoin, typescript, viem
- Language: TypeScript
- Homepage:
- Size: 421 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# JPYC Node SDKs
[](./LICENSE)
[](https://github.com/jcam1/sdks/issues/new/choose)
Monorepo for JPYC Node SDKs.
## 🌈 Available SDKs
Please refer to `README`s of each SDK for the version specific details.
| SDK | `README` |
| -----: | :----------------------------------------- |
| `core` | [packages/core](./packages/core/README.md) |
| `v1` | [packages/v1](./packages/v1/README.md) |
## 🔨 Development
### Git Submodules
This repo uses [Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to be in sync with [JPYCv2](https://github.com/jcam1/JPYCv2/tree/main) repo.
To include submodules when cloning the repo, add `--recursive` option like below.
```sh
$ git clone --recursive https://github.com/jcam1/sdks.git
```
### Yarn Workspaces
This repo uses [Yarn Workspaces](https://yarnpkg.com/features/workspaces) primarily as a monorepo management tool. Please refer to the inserted link for details.
> [!NOTE]
> Please use Node `v20.12.0` for this repo.
To install dependencies for all the workspaces, run the following.
```sh
# cd into this repo
$ cd sdks
# Install dependencies
$ yarn
```
### Yarn Scripts
To run yarn scripts defined in workspaces, run the following.
```sh
$ yarn workspace ${workspace_name} run ${command_name}
```
### Dependencies
To add dependencies, run one of the following. To prevent unexpected behaviors, always pin the exact versions of the dependencies to be installed.
```sh
# Add dependencies to the specified workspace
$ yarn workspace ${workspace_name} add -E ${dependencies}
# Add dev dependencies to the specified workspace
$ yarn workspace ${workspace_name} add -E -D ${dependencies}
# Add dev dependencies to the workspaces root
$ yarn add -E -D -W ${dependencies}
```
To remove dependencies, run one of the following.
```sh
# Remove dependencies from the specified workspace
$ yarn workspace ${workspace_name} remove ${dependencies}
# Remove dependencies from the workspaces root
$ yarn remove -W ${dependencies}
```
### Documentation
To generate Markdown documentation from source code, run the following.
```sh
$ yarn run docs
```
## 🔥 How to Contribute
We appreciate your interest to contribute to this project! Please read the following steps to see how to contribute to this project.
### 1. Create an Issue
The first thing to do is to create a new issue. Feel free to create new issues from [here](https://github.com/jcam1/sdks/issues/new/choose) to propose/request new features or report bugs.
### 2. Clone This Repository
Next, clone this repo. Our default branch is `develop`.
```sh
$ git clone --recursive https://github.com/jcam1/sdks.git
```
### 3. Checkout to a New Branch
You then need to checkout to a new branch (name whatever you would like) from the cloned `develop` branch.
```sh
$ git checkout -b ${your_branch_name}
```
### 4. Write Code
Now, write code to implement the proposed features and/or to fix bugs.
### 5. Open a Pull Request
Finally, open a new PR from your branch to `develop` branch to describe what you'll have done.