Spaces:
Sleeping
Sleeping
File size: 3,189 Bytes
61d39e2 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 |
<h3 align="center">Puter.js</h3>
<p align="center">The official JavaScript SDK for <a href="https://puter.com">Puter.com</a></p>
<p align="center">Free, Serverless, Cloud and AI from the frontend code.</p>
<p align="center">
<a href="https://developer.puter.com" target="_blank">Learn More</a>
·
<a href="https://docs.puter.com" target="_blank">Docs</a>
·
<a href="https://developer.puter.com/tutorials">Tutorials</a>
·
<a href="https://github.com/Puter-Apps/">Examples</a>
·
<a href="https://twitter.com/HeyPuter">X</a>
</p>
<br>
## Installation
### NPM:
```sh
npm install @heyputer/puter.js
```
### CDN:
Include Puter.js directly in your HTML via CDN in the `<head>` section:
```html
<script src="https://js.puter.com/v2/"></script>
```
<br>
## Usage
### Browser
#### ES Modules
```js
import {puter} from '@heyputer/puter.js';
// or
import puter from '@heyputer/puter.js';
// or
import '@heyputer/puter.js'; // puter will be available globally
```
#### CommonJS
```js
const {puter} = require('@heyputer/puter.js');
// or
const puter = require('@heyputer/puter.js');
// or
require('@heyputer/puter.js'); // puter will be available globally
```
#### Node.js (with Auth Token)
```js
const {init} = require("@heyputer/puter.js/src/init.cjs"); // NODE JS ONLY
// or
import {init} from "@heyputer/puter.js/src/init.cjs";
const puter = init(process.env.puterAuthToken); // uses your auth token
const puter2 = init(process.env.puterAuthToken2); // use some other auth token
```
<br>
## Usage Example
After importing, you can use the global `puter` object:
```js
// Print a message
puter.print('Hello from Puter.js!');
// Chat with GPT-5 nano
puter.ai.chat('What color was Napoleon\'s white horse?').then(response => {
puter.print(response);
});
```
<br>
## Starter Templates
You can also use one of the following templates:
- Client-side projects: [Angular](https://github.com/HeyPuter/angular), [React](https://github.com/HeyPuter/react), [Next.js](https://github.com/HeyPuter/next.js), [Vue.js](https://github.com/HeyPuter/vue.js), [Vanilla.js](https://github.com/HeyPuter/vanilla.js)
- Node.js + Express: [Node.js + Express template](https://github.com/HeyPuter/node.js-express.js)
<br>
## Setting Custom Origins
By default puter.js uses the official Puter API and GUI origins. You can customize these origins by setting global variables before importing the SDK like so:
```js
// For API origin
globalThis.PUTER_API_ORIGIN = 'https://custom-api.puter.com';
// For GUI origin
globalThis.PUTER_ORIGIN = 'https://custom-gui.puter.com';
import {puter} from '@heyputer/puter.js'; // or however you import it for your env
```
<br>
---
## Documentation & Community
- [Developer Site](https://developer.puter.com)
- [API Docs](https://docs.puter.com)
- [Live Demo](https://docs.puter.com/playground/)
- [Puter.com](https://puter.com)
- [Discord](https://discord.com/invite/PQcx7Teh8u)
- [Reddit](https://reddit.com/r/puter)
- [X (Twitter)](https://twitter.com/HeyPuter)
## License
Apache-2.0
|