README.md

Ampli iOS SDK (Swift)

An example app using the Ampli Swift SDK

Usage

Setup the project

You will need to do the following before running the app. 1.Set up environment variable with your API keys

1. Go to Edit Scheme > Run > Arguments > Environment Variables section
2. Set your Amplitude API key with name AMPLITUDE_API_KEY
3. pod install
4. Open AmpliSwiftSampleApp.xcworkspace with Xcode

Run the app

You can run the app using the events from our sample tracking plan. This will log events to your Amplitude project.

• Just click on run in Xcode

Pull your Ampli SDK

If you want to use your own tracking plan and Ampli SDK

1. npm i -g @amplitude/ampli
2. ampli pull
3. Update AmpliSwiftSampleAppApp, TextView.swift or ContentView.swift to use the events from your tracking plan

Project structure

• README.md - you are here *
• Podfile - pods dependency
• Shared/
  • AmpliSwiftSampleAppApp - Example user app using Ampli SDK. A good place to start.
  • TextView - Ampli SDK usage in a TextView.
  • ContentView - Ampli SDK usage in a ContentView.
  • Ampli/
    • Ampli.swift - Generated SDK, don't modify by hand. Update with ampli pull