https://github.com/nylas/nylas-js
JavaScript SDK for the Nylas Platform API
https://github.com/nylas/nylas-js
Last synced: 6 months ago
JSON representation
JavaScript SDK for the Nylas Platform API
- Host: GitHub
- URL: https://github.com/nylas/nylas-js
- Owner: nylas
- License: mit
- Created: 2022-07-18T20:33:37.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-16T16:10:21.000Z (about 3 years ago)
- Last Synced: 2025-06-04T00:04:33.143Z (7 months ago)
- Language: TypeScript
- Size: 26.4 KB
- Stars: 1
- Watchers: 33
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Nylas JavaScript SDK
This is the GitHub repository for the Nylas JavaScript SDK. The Nylas Communications Platform provides REST APIs for [Email](https://developer.nylas.com/docs/connectivity/email/), [Calendar](https://developer.nylas.com/docs/connectivity/calendar/), and [Contacts](https://developer.nylas.com/docs/connectivity/contacts/), and the Nylas Javascript SDK is the quickest way to build your integration using JavaScript.
Here are some resources to help you get started:
- [Quickstart](https://developer.nylas.com/docs/the-basics/quickstart/)
- [Nylas API Reference](https://developer.nylas.com/docs/api/)
## ⚙️ Install
To install the Nylas JavaScript SDK, you will first need to have [npm](https://www.npmjs.com/get-npm) installed on your machine.
Then, head to the nearest command line and run the following:
```bash
npm install @nylas/nylas-js
```
To install this package from source, clone this repo and run `npm install` from inside the project directory:
```bash
git clone https://github.com/nylas/nylas-js.git
cd nylas-js
npm install
```
## ⚡️ Usage
The entrypoint for the SDK is `Nylas`, which can be imported as an ES module and instantiated:
```javascript
import Nylas from 'nylas-js'
const nylas = new Nylas({
// Config
});
```
### Configuration options
These are the following options that can be passed in to configure an instance of the Nylas JS SDK
#### `serverBaseUrl`
The URL of the backend server configured with the Nylas middleware or Nylas routes implemented.
## 💙 Contributing
Interested in contributing to the Nylas JavaScript SDK project? Thanks so much for your interest! We are always looking for improvements to the project and contributions from open-source developers are greatly appreciated.
Please refer to [Contributing](Contributing.md) for information about how to make contributions to this project. We welcome questions, bug reports, and pull requests.
## 📝 License
This project is licensed under the terms of the MIT license. Please refer to [LICENSE](LICENSE.txt) for the full terms.