https://github.com/stitchng/adonis-mixpanel
An addon/plugin package to provide Mixpanel data collection services in AdonisJS 4.0+
https://github.com/stitchng/adonis-mixpanel
adonis-framework adonisjs engagement funnels mixpanel mixpanel-api
Last synced: 8 months ago
JSON representation
An addon/plugin package to provide Mixpanel data collection services in AdonisJS 4.0+
- Host: GitHub
- URL: https://github.com/stitchng/adonis-mixpanel
- Owner: stitchng
- License: mit
- Created: 2019-06-10T18:53:04.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-01-10T10:48:42.000Z (over 4 years ago)
- Last Synced: 2025-08-24T21:49:40.078Z (10 months ago)
- Topics: adonis-framework, adonisjs, engagement, funnels, mixpanel, mixpanel-api
- Language: JavaScript
- Homepage:
- Size: 55.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# adonis-mixpanel
An addon/plugin package to provide Mixpanel data collection and tracking services in AdonisJS 4.0+
[![NPM Version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Coveralls][coveralls-image]][coveralls-url]
## Getting Started
>Install from the NPM Registry - (Please read the **instructions.md** file to learn how to setup this package properly).
```bash
$ adonis install adonisjs-mixpanel
```
## Usage
>Import and use in controllers or the standard **AdonisJS Event Bus**
```js
const mixpanel = use('MixPanel')
const User = use('App/Models/User')
class UserController {
async fetch({ request, response }){
let allUsers = await User.all()
return response.status(200).json({
users:allUsers
});
}
async register({ request, response }) {
let user_details = request.only([
'dob',
'email',
'phone',
'first_name',
'last_name'
])
let newUser = await User.create(user_details)
// track a new user registered to the web OR mobile app
mixpanel.trackUserBasicAttributes(
newUser.toJSON()
);
return response.status(201).json({
message:'User Created!',
user: newUSer.toJSON()
});
}
}
module.exports = UserController
```
>More examples
```js
const mixpanel = use('MixPanel')
const User = use('App/Models/User')
class BillingController {
async payment({ request, response }){
let user = await User.findBy('id', 1)
// track the charge made on a user for using the web OR mobile app
// which ties to revenue from the user for the app
mixpanel.trackUserBillingCharge(
user,
40000 // Naira
)
}
}
module.exports = BillingController
```
>This library can also be used to track events using the `mixtrack` named middleware.
```js
const Route = use('Route')
Route.group(() => {
Route.get('/all', 'UserController.fetch')
Route.put('/update/email', function({ auth, request, response }) {
const user = await auth.getUser()
user.merge({
email: request.input('email', null)
})
await user.save() // send to database
await user.reload() // refresh with new email
request.user = user.toJSON()
return response.status(200).send('User Updated Email!')
}).middleware (
['auth', 'mixtrack:set;email']
) // track updated data for user via 'email'
})
.prefix('user')
```
## License
MIT
## Running Tests
```bash
npm i
```
```bash
npm run lint
npm run test
```
## Credits
- [Ifeora Okechukwu](https://twitter.com/isocroft)
## Contributing
See the [CONTRIBUTING.md](https://github.com/stitchng/adonis-mixpanel/blob/master/CONTRIBUTING.md) file for info
[npm-image]: https://img.shields.io/npm/v/adonisjs-mixpanel.svg?style=flat-square
[npm-url]: https://npmjs.org/package/adonisjs-mixpanel
[travis-image]: https://img.shields.io/travis/stitchng/adonis-mixpanel/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/stitchng/adonis-mixpanel
[coveralls-image]: https://img.shields.io/coveralls/stitchng/adonis-mixpanel/master.svg?style=flat-square
[coveralls-url]: https://coveralls.io/github/stitchng/adonis-mixpanel
## Support
**Coolcodes** is a non-profit software foundation (collective) created by **Oparand** - parent company of StitchNG, Synergixe based in Abuja, Nigeria. You'll find an overview of all our work and supported open source projects on our [Facebook Page](https://www.facebook.com/coolcodes/).
>Follow us on facebook if you can to get the latest open source software/freeware news and infomation.
Does your business depend on our open projects? Reach out and support us on [Patreon](https://www.patreon.com/coolcodes/). All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.