# Journify JavaScript SDK This SDK enables you to send your data to Journify back-office without any additional integrations for new added destinations. # Quickstart The easiest and quickest way to get started with the SDK is to [use it through Journify](#using-with-journify). Alternatively, you can [install it through NPM](#using-as-an-npm-package) or simply [add it to your HTML page](#using-in-html-page) and do the instrumentation yourself. ## Using with Journify 1. Create a javascript source at [Journify](https://app.journify.io) and you will automatically get a snippet that you can add to your website. For more information visit our [documentation](https://docs.journify.io/sources/javascript-sdk). 2. Start tracking! ## Using as an NPM package 1. Install the package ```sh # npm npm install @journifyio/js-sdk # yarn yarn add @journifyio/js-sdk # pnpm pnpm add @journifyio/js-sdk ``` 2. Import the package into your project and you're good to go (with working types)! ```ts import * as Journify from "@journifyio/js-sdk"; Journify.load({ writeKey: '' }) Journify.identify('user-id-1', {email: "user-1@mail.com"}) document.body?.addEventListener('click', () => { Journify.track('document body clicked!') }) ``` ## Using in html page Add the following script tag at the top of your ``: ```html ``` # Contributing You can contribute to Journify JavaScript SDK by forking the repo and making pull requests on the `main` branch. To publish a new version, you need to add a prefix to your pull request title following the [semantic versioning spec](https://semver.org/): * **[MAJOR]** \{Pull request title\} * **[MINOR]** \{Pull request title\} * **[PATCH]** \{Pull request title\} Once your PR is merged and the CI pipeline is passed, your code will be published to npm. ## Test your changes using the playground in watch mode 1. Install the dependencies (done once) ```sh yarn install ``` 2. Install the playground dependencies (done once) ```sh cd examples/react-playground yarn install cd - ``` 3. Build the package in watch mode ```sh yarn build-watch ``` 4. In another terminal tab, start the playground ```sh yarn playground ``` # License This project is licensed under MIT license.