https://github.com/amplitude/amplitude-typescript
TypeScript Amplitude Analytics SDK
https://github.com/amplitude/amplitude-typescript
analytics javascript nodejs sdk typescript
Last synced: 7 days ago
JSON representation
TypeScript Amplitude Analytics SDK
- Host: GitHub
- URL: https://github.com/amplitude/amplitude-typescript
- Owner: amplitude
- License: mit
- Created: 2022-01-19T05:07:55.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-05-12T22:55:56.000Z (11 months ago)
- Last Synced: 2025-05-12T23:19:05.507Z (11 months ago)
- Topics: analytics, javascript, nodejs, sdk, typescript
- Language: TypeScript
- Homepage: https://amplitude.github.io/Amplitude-TypeScript/
- Size: 16.6 MB
- Stars: 154
- Watchers: 53
- Forks: 44
- Open Issues: 97
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Amplitude-TypeScript
This is Amplitude's latest version of the JavaScript SDK, written in TypeScript.
## Development
If you plan on contributing to this SDK, here's how you can start.
1. Clone GitHub repo
2. Install dependencies
3. Build and link packages
```
$ git clone git@github.com:amplitude/Amplitude-TypeScript.git
$ nvm use
$ pnpm --version
$ pnpm install
$ pnpm build
```
Check our guidelines for repo contributions on [CONTRIBUTING.md](https://github.com/amplitude/Amplitude-TypeScript/blob/main/CONTRIBUTING.md).
## Projects
* Amplitude SDK for Web
* [@amplitude/analytics-browser@^2](https://github.com/amplitude/Amplitude-TypeScript/tree/main/packages/analytics-browser)
* [@amplitude/analytics-browser@^1](https://github.com/amplitude/Amplitude-TypeScript/tree/v1.x/packages/analytics-browser)
* [Installation and Quick Start](https://www.docs.developers.amplitude.com/data/sdks/browser-2/)
* Amplitude SDK for Node.js
* [@amplitude/analytics-node](https://github.com/amplitude/Amplitude-TypeScript/tree/main/packages/analytics-node)
* [Installation and Quick Start](https://www.docs.developers.amplitude.com/data/sdks/typescript-node/)
* Amplitude SDK for React Native
* [@amplitude/analytics-react-native](https://github.com/amplitude/Amplitude-TypeScript/tree/main/packages/analytics-react-native)
* [Installation and Quick Start](https://www.docs.developers.amplitude.com/data/sdks/typescript-react-native/)
## Testing Locally
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 `pnpm 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](/test-server/README.md)
### Troubleshooting
If you ever see an error that looks like this while running an Nx command (pnpm test, pnpm 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
## Documentation
See our [Typescript SDK](https://amplitude.github.io/Amplitude-TypeScript/) Reference for a list and description of all available SDK methods.