Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lens-protocol/lens-sdk
The official SDK to interact with the Lens Protocol
https://github.com/lens-protocol/lens-sdk
Last synced: 6 days ago
JSON representation
The official SDK to interact with the Lens Protocol
- Host: GitHub
- URL: https://github.com/lens-protocol/lens-sdk
- Owner: lens-protocol
- License: mit
- Created: 2022-11-29T15:59:13.000Z (about 2 years ago)
- Default Branch: next
- Last Pushed: 2024-12-26T14:08:22.000Z (13 days ago)
- Last Synced: 2024-12-26T17:04:55.632Z (13 days ago)
- Language: TypeScript
- Homepage: https://docs.lens.xyz/docs/what-is-lens
- Size: 47.4 MB
- Stars: 237
- Watchers: 6
- Forks: 80
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-lens-protocol - Lens SDK - Official Lens SDK ⭐️ (Development / Libraries & Tools)
README
# Lens SDK
The official SDK for the Lens 🌿.
## Table of Contents
- [Installation](#installation)
- [Development Workflow](#development-workflow)
- [Contributing](#contributing)
- [License](#license)
## Installation
## Development Workflow
This section is for developers who want to contribute to the SDK.
### Initial Setup
Clone the repository:
```bash
git clone https://github.com/lens-network/sdk.git
```
Install the dependencies:
```bash
pnpm install
```
### Pre-requisites:
- Node.js: >= v20. See [installation guide](https://nodejs.org/en/download/package-manager).
- pnpm: v9.1.2. See [installation guide](https://pnpm.io/installation).
Use [nvm](https://github.com/nvm-sh/nvm) to manage your Node.js versions. Run the following command in the project root folder:
```bash
nvm use
```
to switch to the correct Node.js version.
Enable [corepack](https://www.totaltypescript.com/how-to-use-corepack) to use the the correct version of `pnpm`.
Run the following command in the project root folder:
```bash
corepack install
```
to install the correct version once. After that corepack will automatically use the correct version of `pnpm` when entering the project folder.
### Usage
Run the tests:
- `pnpm test:client`: Run the tests for the `@lens-protocol/client` package.
Lint the code:
```bash
pnpm lint
```
Compile the code:
```bash
pnpm build
```
Clean the build:
```bash
pnpm clean
```
Create a new package:
```bash
pnpm new:lib
```
### IDE Setup
The project uses [Biome](https://biomejs.dev/) to format and lint the code. You can install the Biome extension for your IDE: https://biomejs.dev/guides/editors/first-party-extensions/
### Publishing
1. Create a new release branch using the `release/X.Y.Z` naming convention.
2. Bumps up version number and updates the changelog.
```bash
pnpm changeset version
```
3. Commit the changes using `chore: bumps up version number` as the commit message.
4. Push the changes to the remote repository.
5. Open a pull request to the `main` branch.
6. Wait for all checks to pass and for the pull request to be approved.
7. Publish the package.
```bash
pnpm changeset publish
```
8. Push tags to the remote repository.
```bash
git push --follow-tags
```
9. Merge the pull request to the `main` branch.
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## License
Lens SDK is [MIT licensed](./LICENSE).