Git Product home page Git Product logo

segment-amplitude's Introduction

Segment-Amplitude Integration

Project Description

Refer to [Project Description] (https://github.com/uduakeren/segment-amplitude/blob/master/Project%20Description.md) for a detailed description of the project.

Project Dependencies

All project dependencies are in package.json file

Technology Stack

Running the Application

To run and test it locally, you need to create a free account with [Amplitude] (https://amplitude.com/signup). Create a test project so that you can obtain an API key. You may also need to obtain some sample event data from [Segment] (https://segment.com/docs/integrations/amplitude/).

Once you have cloned the project, the following are the steps to run the application:

### Step I: Install dependencies
npm install

### Step II: Start up application server
npm start

### Step III: Update amplitude-integration module with your api key

### Step IV: Run the tests
npm test

Development: Extending the Application

To add implementation for integration with other partners, after an accepted Git Pull request, you need to create the following modules:

Router

  • Define integration endpoint: /v1/{NAME_OF_PARTNER}. For example, to integrate with Marketo, the endpoint would be: /v1/marketo
  • Include endpoint in /routes/index.js
  • (Optional) Add test case for new endpoint in : /tests/index.js

Integration

  • Create /integration/{NAME_OF_PARTNER}-integration.js module that would contain all the specific integration details for partner.
  • Modify /integration/integration-builder.js to include integration object for new partner.
  • (Optional) Create test for new integration module in /tests/{NAME_OF_PARTNER}-integration.js

Deployment:

This project is currently hosted on [Heroku] (https://www.heroku.com) and the API endpoint is [https://segment-integrations.herokuapp.com] (https://segment-integrations.herokuapp.com)

The endpoint for all partner-integrations are of the form https://segment-integrations.herokuapp.com/v1/{NAME_OF_PARTNER}. For example, the Amplitude API endpoint is https://segment-integrations.herokuapp.com/v1/amplitude

To deploy on Heroku, use command git push heroku master

segment-amplitude's People

Contributors

uduakeren avatar

Watchers

James Cloos avatar Uduak 'Eren avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.