# Glific - Two Way Open Source Communication Platform

[![License: AGPL v3](](
[![Code coverage badge](](
[![Glific on](](
![GitHub issues](
[![codebeat badge](](

## Packages Needed

Install the following packages using your favorite package manager. Links are provided for some

  * [Install Elixir](
    1. For Ubuntu users you also need to install the `inotify-tools` package
  * [Install Postgres](
    1. For Postgres, for the development server, we default to using postgres/postgres as the username/password. This is configurable

## Download code

  * [Download the latest code from GitHub](

## Setup
  * Copy the file: `config/dev.secret.exs.txt` to `config/dev.secret.exs` and edit it with your credentials
  * Run `mix setup`
  * Run `mix phx.server`

## Here we go

Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.

## Install glific-frontend

You cannot do much from the glific-backend unless you are an API developer. To see Glific in its glory, please
install [Glific Frontend](

## Create and link your Gupshup Account

The frontend and backend are great, but you will need an account with a WhatsApp Business Provider to explore the
application. The currently supported backend is [Gupshup](
You will need to do the following:

  * Create a [Gupshup Account](
  * Install [ngrok](
  * Start ngrok to proxy port 4000: `$ ngrok http 4000` (do this in a new window))
    * Remember the URL it assigns you, something like: ``
    * Also start the backend server: `mix phx.server` (do this in a new window)
  * Create a [WhatsApp Messaging App on Gupshup](
  * You can name it `GlificTest` and ensure the `App Type` is `Access API`
  * Goto the [Settings Page](
  * On that page, Search for `Callback URL / Link your Bot`
  * Enter your callback URL that ngrok gave you, add: `/gupshup` to the end. Something like:
  * Click `Set`. It should give you a `Callback set successfully` message. If not, check the above steps.
  * Edit `config/dev.secret.exs` in the backend directory
  * You will need to enter your API Key, which can be found by clicking on your profile in the top left
  corner of your gupshup dashboard

## Updating your instance

For v0.x releases, we will be resetting the DB and not saving existing state. Run the following commands
to update your codebase from the glicic repository.

  * Ensure you are in the top level directory of the glific api code.
  * Get the latest code from master: `git switch master; git pull`
  * Ensure you have not modified any files in this directory, by running: `git status`
  * Run the setup command: `mix setup`

## Documentation

  * [GraphQL API docs](
  * [Code docs](

## Learn more

### Glific
  * [Demo Video](
  * [One Pager](
  * [Product Features](
  * [Glific Blogs](
  * [Google Drive](

## Chat with us

  * [Chat on Discord](