This is Amplitude's latest version of the JavaScript SDK, written in TypeScript.
If you plan on contributing to this SDK, here's how you can start.
- Clone GitHub repo
- Install dependencies
- Build and link packages
$ git clone git@github.com:amplitude/Amplitude-TypeScript.git
$ nvm use
$ yarn --version
$ yarn install
$ yarn build
Check our guidelines for repo contributions on CONTRIBUTING.md.
- Amplitude SDK for Web
- Amplitude SDK for Node.js
- Amplitude SDK for React Native
To test the SDK locally, you can run our test server.
Before running the test server for the first time, copy ".env.example" as ".env" and replace the variables in '.env' with your own variables.
Run yarn dev to run the test server. It will open up to the home page automatically in your default browser.
For more details visit the Test Server README.md
If you ever see an error that looks like this while running an Nx command (yarn test, yarn build, etc...):
Lerna (powered by Nx) DB transaction operation error: SqliteFailure(Error { code: SystemIoFailure, extended_code: 522 }, Some("disk I/O error"))
Run npx nx reset and try again
See our Typescript SDK Reference for a list and description of all available SDK methods.