Community
Getting Started
Here is an overview of how to get the Text Editor SDK up and running in your app in just a few steps.
Create an application
From My Appsopen in new window, create an application and give it a name, such as "Grammarbot" or "Grammarbot Development." You can edit your application name any time, and set a separate, public application name and developer name later if you’re allowing users to connect their Grammarly accounts.
When you create an app, you'll automatically be taken to the App Console. Here, you can manage your app and add web or desktop clients.
TIP
Only alphanumeric characters, symbols like - (hyphen), ’ (apostrophe), , (comma), + (plus), and the blank space are allowed in the app name and client name.
Install the Text Editor SDK
In the App Console, you'll see a quick start guide for the Text Editor SDK. The guide contains client-specific installation commands and code snippets you can copy. With just a few lines of code, you can add the Grammarly Text Editor Plugin to the desired HTML elements in your app.
You can watch our YouTube tutorialopen in new window for a walkthrough, and view many examplesopen in new window in our GitHub repository.
In the following docs, you’ll find more installation and usage options for each client platform we support:
- Text Editor SDK for JavaScript
- Text Editor SDK for React
- Text Editor SDK for Vue
- Text Editor SDK for Electron (desktop clients)
Set up credentials
Below the quick start guide, you'll find the client credentials. The client ID is the unique public identifieropen in new window for your application. You will need it when initializing the Text Editor SDK in your application. The code samples in the quick start already contain this client ID.
Additionally, for web clients, you can configure the allowed origins. For desktop clients, you can provide redirect URIs, which are required for the connected accounts OAuth flow on desktop.
Preparing for production
Before making your app available in a production environment, please take note of the recommendations in Securing Your Integration.