Preparing for Couchbase Lite JavaScript
Description — Prerequisites for the installation of Couchbase Lite JavaScript
Abstract — Laying out the prerequisites and preparatory steps before installing Couchbase Lite JavaScript
Browser Compatibility
The Couchbase Lite JavaScript SDK is compatible with all major modern browsers, including Safari, Chrome, Firefox, and Microsoft Edge, across both desktop and mobile platforms. It uses IndexedDB as the underlying storage engine to ensure reliable offline persistence and performance.
Compatibility has been verified on the following browser versions (and newer):
-
Safari 17+
-
Chrome 142+
-
Firefox 144+
| Sync behaviour may be limited in private browsing modes (especially Chrome). |
The SDK also runs seamlessly in Progressive Web App (PWA) environments, enabling installable, native-like usage scenarios.
Prerequisites
A modern ES2022+ JavaScript environment is needed for execution as the SDK uses promises and async/await features. Node.js 22+ is also required for development and build tooling.
If you are using Sync Gateway or App Services as a backend for your browser-based applications, you should enable CORS before you can synchronize data:
-
For App Services, see CORS Configuration for App Services
-
The CORS configuration should be done in the Sync Gateway Bootstrap Configuration.
| Users must be on Sync Gateway 3.3.1 or 4.0.1 and above to sync data with the JavaScript SDK. |