code-sdk

KO | EN

gitlite — search

#javascript #hacktoberfest #llm #go #android #machine-learning #rust #deep-learning #macos #java #awesome #vue #pytorch #openai

(★ 22)

Permissionless micropayments for the web

code-sdk Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Code SDK

[![npm][npm-image]][npm-url]
[![npm-downloads][npm-downloads-image]][npm-url]
[![discord-badge]][discord]
![license][license-image]

[npm-downloads-image]: https://img.shields.io/npm/dt/@code-wallet/elements?style=flat
[npm-image]: https://img.shields.io/npm/v/@code-wallet/elements?style=flat
[npm-url]: https://www.npmjs.com/package/@code-wallet/elements
[license-image]: https://img.shields.io/badge/license-MIT-blue?style=flat
[discord-badge]: https://img.shields.io/discord/1161288078980288544?color=%237289DA&logo=discord&logoColor=%23FFFFFF
[discord]: https://discord.gg/T8Tpj8DBFp

The Code SDK is a set of JavaScript packages that enables any web developer to integrate Code into their website or web app and easily start accepting payments for as little as 5 cents with no sign up required and just a few lines of code.

See the [docs](https://code-payments.github.io/code-sdk/docs/guide/introduction) for more information.

##  What is Code?

[Code](https://getcode.com) is a mobile wallet app that leverages self custodial blockchain technology to deliver a seamless payments experience that is instant, global, and private.

##  Installation

The Code SDK is available as a set of JavaScript packages on npm, and can be used in both the browser and on the server.

```bash
make build
```

## Contributors

If you're interested in contributing to the Code SDK, please see the
[contributing](#contributing) section below.

Our Code mobile apps and services all use [gRPC](https://grpc.io/) to
communicate. If you're planning on making SDK contributions, you'll likely want
to run the code-sdk
[proxy](https://github.com/code-payments/code-sdk/blob/main/packages/proxy/example/index.ts)
server locally. Running the proxy locally is highly recommended as you'll see
the interactions between the SDK elements and the Code services. This is
especially useful when you're developing new elements or views. Note that we use
a custom gRPC envelope protocol as the existing gRPC-web libraries do not
support bidi streams over HTTP/1 and are [not binary
stable](https://github.com/protocolbuffers/protobuf-go/blob/v1.28.1/proto/encode.go#L216-L219).

The following command will start a local server that proxies gRPC requests over
WebSockets or HTTP POSTs using HTTP/1 gRPC envelopes. 
    
```bash
cd packages/proxy
npm run dev
```

Next, start the elements and views packages. These are the main packages that
you will be working with. The elements package contains the SDK elements flows
and the views package contains the iframes that are actually embedded into the
website.

Each of these packages will start a local server that you can use to
test the SDK elements and views.

```bash
cd packages/elements
npm run dev
```

```bash
cd packages/views
npm run dev
```

You can now visit `http://localhost:8760/` to see the elements and views in
action.

Note: Both the elements and views packages assume the proxy is on
`localhost:3000`. If you're running the proxy on a different port, you'll need
to update each package.

## Getting Help

If you have any questions or need help integrating Code into your website or application, please reach out to us on [Discord](https://discord.gg/T8Tpj8DBFp) or [Twitter](https://twitter.com/getcode).

##  Contributing

For now the best way to contribute is to share feedback on [Discord](https://discord.gg/T8Tpj8DBFp). This will evolve as we continue to build out the platform and open up more ways to contribute.

code-sdk

code-sdk Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

code-sdk

code-sdk Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README