@knovator/novu-connector
v1.0.0
Published
<div id="top"></div>
Downloads
3
Readme
About The Project
@knovator/novu-connector
is package built to add user to the admin organization and get user login token.
Built With
Getting Started
To use this package you have to first setup your account on novu or on self hosted novu, and should be having your setup/admin credentials ready.
Installation
- Install NPM packages
npm install @knovator/novu-connector # or yarn add @knovator/novu-connector
Usage
After successfully creating account and having username
and password
credentials we can start using it,
Configuration
- In app.js/main.js, you have to first configure package to use different baseURL,
const { setConfig } = require('@knovator/novu-connector'); setConfig('http://localhost:3000', false);
setConfig
function accepts two parameters,baseUrl
- baseUrl to call the APIlog
- boolean to toggle logging in console
Registering User
- To new member to current member team, we can use
addUser
functionconst { addUser } = require('@knovator/novu-connector'); await addUser( { email: "[email protected]", password: "admin1234" }, { email: "[email protected]", password: "johndoe123", role: "member", firstName: "John", lastName: "Doe" } );
- first parameter indicates admin credentials
- second parameter indicates new user credentials, in which role can be
member
oradmin
Login User
- To login the user, we can use
login
functionconst { login } = require('@knovator/novu-connector'); await login("[email protected]", "johndoe123");
- Returns
{ token: '...' }
in case of credentials are correct.
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE.txt
for more information.
Contact
Knovator Technologies
- Twitter @knovator
- Web https://knovator.com/
Project Link: https://github.com/knovator/novu-connector