appambit
v0.1.0
Published
Lightweight SDK for analytics, events, logging, crashes, and offline support. Simple setup, minimal overhead.
Maintainers
Readme
AppAmbit React Native SDK
Track. Debug. Distribute. AppAmbit: track, debug, and distribute your apps from one dashboard.
Lightweight SDK for analytics, events, logging, crashes, and offline support. Simple setup, minimal overhead.
Full product docs live here: docs.appambit.com
Contents
- Features
- Requirements
- Install
- Quickstart
- Usage
- Release Distribution
- Privacy and Data
- Troubleshooting
- Contributing
- Versioning
- Security
- License
Features
- Session analytics with automatic lifecycle tracking
- Event tracking with custom properties
- Error logging for quick diagnostics
- Crash capture with stack traces and threads
- Offline support with batching, retry, and queue
- Create multiple app profiles for staging and production
- Small footprint
Requirements
- Node >= 20
- Yarn >=3.6.1
- Android SDK with:
- Android 5.0+
- compileSdkVersion 34
- targetSdkVersion 34
- minSdkVersion 21
- iOS SDK with:
- Xcode 15+ (for iOS)
- macOS 13+
Install
NPM
Add the package to your React Native project:
npm install appambit
# or specify version
npm install [email protected]Quickstart
Initialize the SDK with your API key.
Javascript
export default function App() {
useEffect(() => {
start("<YOUR-APPKEY>");
}, []);
}Android App Requirements
Add these permissions to your AndroidManifest.xml:
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.INTERNET" />Usage
Session activity – automatically tracks user session starts, stops, and durations
Track events – send structured events with custom properties
trackEvent("ButtonClicked", {"Count": "41"})Logs: add structured log messages for debugging
try { throw new Error(); } catch (e) { logError( { stack: e.stack, exception: e, classFqn: e.constructor.name, properties: {"user_id": "1"} }, ); }Crash Reporting: uncaught crashes are automatically captured and uploaded on next launch
Release Distribution
Upload your APK, AAB, or IPA directly to your AppAmbit dashboard. Distribute release builds through:
- Direct install links
- Email distribution
- Environment-specific channels
Privacy and Data
- The SDK batches and transmits data efficiently
- You control what is sent — avoid secrets or sensitive PII
- Supports compliance with Google Play policies
For details, see the docs: docs.appambit.com
Troubleshooting
- No data in dashboard → check API key, endpoint, and network access
- React Native dependency not resolving → run
npm installoryarn installand verify again - Crash not appearing → crashes are sent on next launch
Contributing
We welcome issues and pull requests.
- Fork the repo
- Create a feature branch
- Add tests where applicable
- Open a PR with a clear summary
Please follow React Native API design guidelines and document public APIs.
Versioning
Semantic Versioning (MAJOR.MINOR.PATCH) is used.
- Breaking changes → major
- New features → minor
- Fixes → patch
Security
If you find a security issue, please contact us at [email protected] rather than opening a public issue.
License
Open source under the terms described in the LICENSE file.
Links
- Docs: docs.appambit.com
- Dashboard: appambit.com
- Discord: discord.gg
- Examples: Sample React Native test app included in repo.
