jerry.tian/fal-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: update readme instructions

Browse Source
This commit is contained in:
Daniel Rochetti 2023-11-21 13:19:58 -08:00
parent c5840192da
commit 7c0b5ba878
No known key found for this signature in database
GPG Key ID: 791E89AB68BDD5DB
1 changed files with 23 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -7,11 +7,11 @@
## About the Project ## About the Project
The fal-serverless JavaScript/TypeScript Client is a robust and user-friendly library designed for seamless integration of fal serverless functions in Web, Node.js, and React Native applications. Developed in TypeScript, it provides developers with type safety right from the start. The fal serverless JavaScript/TypeScript Client is a robust and user-friendly library designed for seamless integration of fal serverless functions in Web, Node.js, and React Native applications. Developed in TypeScript, it provides developers with type safety right from the start.
## Getting Started ## Getting Started
The `serverless-js` library serves as a client for fal serverless Python functions. For guidance on creating your functions, refer to the [quickstart guide](https://fal.ai/docs). The `@fal-ai/serverless-client` library serves as a client for fal serverless Python functions. For guidance on creating your functions, refer to the [quickstart guide](https://fal.ai/docs).
### Client Library ### Client Library
@ -20,23 +20,26 @@ This client library is crafted as a lightweight layer atop platform standards li
> **Note:** > **Note:**
> Ensure you've reviewed the [getting started guide](https://fal.ai/docs) to acquire your credentials, browser existing APIs, or create your custom functions. > Ensure you've reviewed the [getting started guide](https://fal.ai/docs) to acquire your credentials, browser existing APIs, or create your custom functions.
1. Start by configuring your credentials: 1. Install the client library
```sh
npm install --save @fal-ai/serverless-client
```
2. Start by configuring your credentials:
```ts ```ts
import * as fal from '@fal-ai/serverless-js'; import * as fal from '@fal-ai/serverless-client';
fal.config({ fal.config({
// Can also be auto-configured using environment variables: // Can also be auto-configured using environment variables:
// Either a single FAL_KEY or a combination of FAL_KEY_ID and FAL_KEY_SECRET // Either a single FAL_KEY or a combination of FAL_KEY_ID and FAL_KEY_SECRET
credentials: 'FAL_KEY_ID:FAL_KEY_SECRET', credentials: 'FAL_KEY_ID:FAL_KEY_SECRET',
}); });
``` ```
2. Retrieve your function id and execute it: 3. Retrieve your function id and execute it:
```ts
```ts const result = await fal.run('my-function-id');
const result = await fal.run('my-function-id'); ```
```
The result's type is contingent upon your Python function's output. Types in Python are mapped to their corresponding types in JavaScript. The result's type is contingent upon your Python function's output. Types in Python are mapped to their corresponding types in JavaScript.
@ -48,7 +51,10 @@ Although the fal client is designed to work in any JS environment, including dir
For example, if you are using Next.js, you can: For example, if you are using Next.js, you can:
1. Instal the proxy library `npm install --save @fal-ai/serverless-proxy` 1. Instal the proxy library
```sh
npm install --save @fal-ai/serverless-proxy
```
2. Add the proxy as an API endpoint of your app, see an example here in [pages/api/\_fal/proxy.ts](https://github.com/fal-ai/serverless-js/blob/main/apps/demo-nextjs-app/pages/api/_fal/proxy.ts) 2. Add the proxy as an API endpoint of your app, see an example here in [pages/api/\_fal/proxy.ts](https://github.com/fal-ai/serverless-js/blob/main/apps/demo-nextjs-app/pages/api/_fal/proxy.ts)
```ts ```ts
export { handler as default } from '@fal-ai/serverless-proxy/nextjs'; export { handler as default } from '@fal-ai/serverless-proxy/nextjs';