Botmetrics

Botmetrics is the easy, secure, open-source way for you to measure and engage with your chat-bot users.

Botmetrics works natively with Messenger, Slack and Kik bots with support for other messaging platforms coming soon.

Deploy to AWS

Analytics

With Botmetrics, you can get analytics for your bot with very little code, and native SDKs available in

Insights

You can gain more insight into the users using your bot and perform sophisticated queries to find out who they are.

Notifications

You can gain more insight into the users using your bot and send then re-engagement notifications based on pre-selected criteria.

Quick Installation

You can deploy Botmetrics with one click to your Heroku account.

One-click deployment to Amazon AWS, Google Cloud and Microsoft Azure is coming soon!

Updating your Heroku installation

Clone the repo to your local computer.
Setup a Heroku git remote for your local instance heroku git:remote -a <your-app-name>
For the first time, you will need to run git push -f heroku master
For subsequent updates, run git pull --rebase origin master && git push heroku master
Run heroku run rake db:migrate for database migrations that need to happen.

Installation on your own Linux server

Make sure you have Ruby 2.3.1 installed along with Rubygems (make sure you have libxslt-dev, libxml2-dev, libpq-dev installed on your machine).
Setup the .env file by running cp .env-example .env
Replace JSON_WEB_TOKEN_SECRET with your own randomized secret.
Replace DATABASE_URL and REDIS_URL with URLs to your Postgres and Redis database URLs respectively. (Postgres and Redis can be on the same machine or different machines).
Run ./script/server to start the server.

Development

cp .env-example .env
Start Redis & Postgres (there's a ./script/redis and ./script/dbstart command that lets you do this easily)
Run ./script/dbreset to reset the database (creates a new one, loads schema and runs rake db:seed)
Run ./script/server to start the server
Visit localhost:3000

Contributing

Join the Slack channel to ask questions
Open a GitHub Issue for bugs/feature requests
Create a GitHub Pull Request to submit patches

Wiki

Extra information can be found in the wiki.

Roadmap

The Botmetrics Roadmap can be seen here.

CircleCI

Running Botmetrics with Docker Compose

Install Docker
Edit docker-compose.yml to update all the instances of JSON_WEB_TOKEN_SECRET, REDIS_URL and DATABASE_URL
Get the database ready with docker-compose run web bundle exec rake db:reset
Bring up the services with docker-compose up in the botmetrics project directory.
Goto localhost:3000 Enjoy!

Deploying Botmetrics to AWS with Convox

Convox is an easy way to deploy dockerized applications to AWS

Sign up for Convox, Install a Rack and Convox CLI.
In your botmetrics directory issue the following commands: convox apps create to create an application called botmetrics
convox services create postgres && convox services create redis this will provision a Postgres and Redis Service on AWS (Go get a coffee.)
Once convox has finished creating the app you can start you first deploy with convox deploy
Set the environment variables for Redis and Postgres
1. convox services will list the names of the postgres and redis service instances.
2. convox service info <service name> will provide the URL for each service.
3. Use convox env set REDIS_URL=<url_from_redis_service> and convox env set DATABASE_URL=<url_from_redis_service>
4. Note the final release ID
After convox deploy from step 5 has finished promote the release with the ENV variables with convox releases promote <release_id>
Setup your database for the first time with convox run web rake db:structure:load db:seed
Get the public URL for your app with convox apps info it's the one that's on port 80
Browse to the URL and Enjoy!

Stay Connected

Follow Botmetrics on Twitter to get the latest updates.

Read the Botmetrics Blog for more How tos, success stories and more.

joburgalex / botmetrics Goto Github PK

botmetrics's Introduction