https://github.com/get-convex/convex-js

TypeScript/JavaScript client library for Convex
https://github.com/get-convex/convex-js

convex data-loading database javascript realtime-database typescript websocket

Last synced: 6 days ago
JSON representation

TypeScript/JavaScript client library for Convex

• Host: GitHub
• URL: https://github.com/get-convex/convex-js
• Owner: get-convex
• License: apache-2.0
• Created: 2023-04-27T23:14:20.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-23T17:06:25.000Z (21 days ago)
• Last Synced: 2024-10-24T22:57:11.103Z (20 days ago)
• Topics: convex, data-loading, database, javascript, realtime-database, typescript, websocket
• Language: TypeScript
• Homepage: https://docs.convex.dev
• Size: 1.06 MB
• Stars: 102
• Watchers: 4
• Forks: 12
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Convex

TypeScript/JavaScript client libraries and CLI for Convex.

Convex is the backend application platform with everything you need to build

your product.

Get started at [docs.convex.dev](https://docs.convex.dev)!

Or see [Convex demos](https://github.com/get-convex/convex-demos).

Open discussions and issues in this repository about Convex

TypeScript/JavaScript clients, the Convex CLI, or the Convex platform in

general.

Also feel free to share feature requests, product feedback, or general questions

in the [Convex Discord Community](https://convex.dev/community).

# Structure

This package includes several entry points for building apps on Convex:

- [`convex/server`](https://docs.convex.dev/api/modules/server): Helpers for

  implementing Convex functions and defining a database schema.

- [`convex/react`](https://docs.convex.dev/api/modules/react): Hooks and a

  `ConvexReactClient` for integrating Convex into React applications.

- [`convex/browser`](https://docs.convex.dev/api/modules/browser): A

  `ConvexHttpClient` for using Convex in other browser environments.

- [`convex/values`](https://docs.convex.dev/api/modules/values): Utilities for

  working with values stored in Convex.

- [`convex/react-auth0`](https://docs.convex.dev/api/modules/react_auth0): A

  React component for authenticating users with Auth0.

- [`convex/react-clerk`](https://docs.convex.dev/api/modules/react_clerk): A

  React component for authenticating users with Clerk.

This package also includes [`convex`](https://docs.convex.dev/using/cli), the

command-line interface for managing Convex projects.

# Building

`npm pack` produces a public build with internal types removed.