Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 1.21 KB

README.md

File metadata and controls

49 lines (34 loc) · 1.21 KB

Bayanplus JS

Lightweight Frontend library written in Typescript for Bayanplus

version downloads

Features ✨

  • You can use it with any frontend framework you want
  • Very simple and light
  • Fully typed

💡 Full Documentation here

Install

To install the packages run in one of these commands

npm install bayanplus-js

or with yarn

yarn add bayanplus-js

Basic usage

import bayanplus from 'bayanplus-js';

// first and most important initiliaze the app with the project id
// you can find the project id on https://bayanplus.co
// you only need to do this once
bayanplus.init({
  projectId: 'xxxxx',
});

// now you can track any event you want like
// you can track as many events you want on any file as long as you initiliazed the app
bayanplus.event('Buy Book');

// after you user has logged in, you can create profile for the user
// by using `set` function
bayanplus.user.set({
  name: 'Salah',
  email: '[email protected]',
  isDarkMode: true,
});