@knovator/novu-connector

@knovator/novu-connector

`@knovator/novu-connector` is package built that register and login the user.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Usage
   • Configuration
   • Registering User
   • Login User
4. Contributing
5. License
6. Contact

About The Project

@knovator/novu-connector is package built to add user to the admin organization and get user login token.

(back to top)

Built With

• Axios
• Typescript

(back to top)

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

1. Install NPM packages

   npm install @knovator/novu-connector
   # or
   yarn add @knovator/novu-connector

(back to top)

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 API
  • log - boolean to toggle logging in console

Registering User

• To new member to current member team, we can use addUser function

  const { addUser } = require('@knovator/novu-connector');
  await addUser(
    { email: "[e-mail]", password: "admin1234" },
    { email: "[e-mail]", 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 or admin

Login User

• To login the user, we can use login function

  const { login } = require('@knovator/novu-connector');
  
  await login("[e-mail]", "johndoe123");

• Returns { token: '...' } in case of credentials are correct.

(back to top)

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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Knovator Technologies

• Twitter @knovator
• Web https://knovator.com/

Project Link: https://github.com/knovator/novu-connector

(back to top)