There is level of understanding middle to advanced level. It is assumed that you know how to use a terminal, install things and have git; for the backend, and for the frontend use install yarn and react.
- Software dependency - Postgres server
- Software dependency - Erlang / Elixir
- Backend - Download
- External service - Gupshup. <-- Get a Free trial to get API-key
- External service - Oban. <-- Needs 100 Euro per month
- Backend - Install certificate
- Backend - Config
- Frontend
- Download and start postgres server
For Postgres, for the development server, we default to using postgres/postgres as the username/password. This is configurable
We tested and developed against the following version:
- postgres : v13.x
- Install Elixir (check package versions below)
For Ubuntu users you also need to install the inotify-tools
package
We tested and developed against the following versions:
- erlang : 24.3.4
- elixir : 1.13.4-otp-24
git clone https://github.com/glific/glific
DO NOT run mix deps.get until the next steps are completed.
Gupshup is an external service that connects to WhatsApp
You will need to do the following:
a. Create a Gupshup Account
b. Create an app and select Access API
c. You can name it NewNameHere
"GlificTest <-- Bot Name is already in use, then use anotherone"
d. Edit glific_backend/config/dev.secret.exs
e. Find your API Key, check top left corner or inside the curl sample message
f. Enter your APP name
Oban is a cron-like library. Glific depends 100% on job processing. Oban is required before running mix for Glific to operate. You must purchase license. When purchashing you must buy WEB+PRO . After you purchased Go to account and get this information and run this in glific_backend
mix hex.repo add oban https://getoban.pro/repo --fetch-public-key SHA256:4/abc/edf/gef+aIWPc --auth-key abdedcqweasdj__KEY_AUTH__asdafasdf
Copy the --auth KEY and run this other command
mix hex.organization auth oban --key abdedcqweasdj__KEY_AUTH__asdafasdf
Make sure your key is in the list
mix hex.repo list
Name URL Public key Auth key
oban https://getoban.pro/repo SHA256:4/abc/edf/gef+aIWPc abdedcqweasdj__KEY_AUTH__asdafasdf
If you see it twice, it will not work and fail, since Oban moved from public repository to private this is how an example of failing looks like
Name URL Public key Auth key
hexpm:oban https://repo.hex.pm/repos/oban SHA256:abc/edf/gef+aIWPc abdedcqweasdj__KEY_AUTH__asdafasdf
oban https://getoban.pro/repo SHA256:4/abc/edf/gef+aIWPc abdedcqweasdj__KEY_AUTH__asdafasdf
this is wrong, and you run mix deps.get it will try to fetch from public and ignore private and fail simply remove the public one
mix hex.repo remove hexpm:oban
Now check again
mix hex.repo list
Name URL Public key Auth key
oban https://getoban.pro/repo SHA256:4/abc/edf/gef+aIWPc abdedcqweasdj__KEY_AUTH__asdafasdf
Before install also you need to create this SSL cert simila to this Go to glific_backend folder in the terminal console.
-
a. Install mkcert (https://github.com/FiloSottile/mkcert)
-
b.
mkcert --install
-
c.
mkcert glific.test api.glific.test
-
d.
mkdir priv/cert
-
e.
mv glific.test* priv/cert
-
f.
cd priv/cert
-
g.
ls -1
Check that glific.test+1-key.pem and glific.test+1.pem existsif not then copy any certificate found in there to the correct names for example if I see:
❯ ls -1
glific.test+*-key.pem
glific.test+*.pem
glific.test+*-key.pem
glific.test+*.pem
❯ cp glific.test+*-key.pem glific.test+1-key.pem
❯ cp glific.test+*.pem glific.test+1.pem
And check again
❯ ls -1
glific.test+*-key.pem
glific.test+*.pem
glific.test+*-key.pem
glific.test+*.pem
glific.test+*-key.pem
glific.test+*.pem
-
h. Check port 4001
sudo lsof -n -i:4001 | grep LISTEN
should return nothing. -
i. Check hosts file
grep glific /etc/hosts
if returns nothing then make sure hosts file has those names added `sudo bash -c 'echo "127.0.0.1 glific.test api.glific.test" >> /etc/hosts'`
-
a. Copy the file:
cp config/dev.secret.exs.txt config/dev.secret.exs
and edit -
b. Copy the file:
cp config/.env.dev.txt config/.env.dev
and edit -
c. Run
source config/.env.dev
-
d. Run
mix deps.get
if this fails try firstmix local.hex --force
thenmix deps.get
if you see this error, then Oban key is wrong or failing. Check step 5. Or contact Oban.
❯ mix deps.get Failed to fetch record for 'hexpm:oban/oban_pro' from registry (using cache instead) This could be because the package does not exist, it was spelled incorrectly or you don't have permissions to it Failed to fetch record for 'hexpm:oban/oban_web' from registry (using cache instead) This could be because the package does not exist, it was spelled incorrectly or you don't have permissions to it ** (Mix) Unknown package oban_pro in lockfile
-
e. Run
mix setup
-
f. Run
mix phx.server
-
g. Another tab of terminal - Start the backend server in iex session:
iex -S mix
-
h. Inside the iex - Update HSM templates:
Glific.Templates.sync_hsms_from_bsp(1)
Now you can visit localhost:4000
from your browser.
You cannot do much from the glific_backend unless you are an API developer. To see Glific in its glory, please install Glific Frontend
git clone https://github.com/glific/glific-frontend
cd glific-frontend
open package.json
nano package.json
Copy config file
cp .env.example .env
Make sure the .env config file looks like this
REACT_APP_API_PREFIX="api"
# localhost
REACT_APP_GLIFIC_API_PORT=4001
REACT_APP_GLIFIC_BACKEND_URL=""
REACT_APP_APPSIGNAL_API_KEY=""
REACT_APP_APPLICATION_NAME="Glific: Two way communication platform"
REACT_APP_LOGFLARE_API_KEY=""
REACT_APP_LOGFLARE_SOURCE_TOKEN=""
REACT_APP_STRIPE_PUBLISH_KEY=""
REACT_APP_RECAPTCHA_CLIENT_KEY="Your recaptch key"
USE Double quotes " " , not single ' ' quotes. And do not leave spaces before or after.
Do not use '' for after the = or leave spaces Broken For example 1
REACT_APP_GLIFIC_BACKEND_URL='gitflic.test'
this will be read like this by react https://%27gitflic.test%27 . notice the %27 which will fail the connection
Broken For example 2
REACT_APP_GLIFIC_BACKEND_URL= gitflic.test'
this will be read like this by react https://%32gitflic.test%27 . notice the %32 which will fail the connection
Broken For example 3
REACT_APP_GLIFIC_BACKEND_URL="gitflic.test "
this will be read like this by react https://gitflic.test%32 . notice the %32 which will fail the connection
Broken For example 4
REACT_APP_GLIFIC_BACKEND_URL="https://gitflic.test"
this will be read like this by react https://https://gitflic.test . notice the extra https:// which will fail the connection
Correct For examples
REACT_APP_GLIFIC_BACKEND_URL="gitflic.test"
REACT_APP_GLIFIC_BACKEND_URL=gitflic.test
Now run install
yarn setup
If there were no failures
yarn start
Go to localhost:3000
from your browser.
- Phone
917834811114
- Password
secret1234
- Install ngrok
- Start ngrok to proxy port 4000:
- Start the backend server:
mix phx.server
$ ngrok http 4000 --host-header=localhost:4000
(do this in a new window))- Remember the URL it assigns you, something like:
https://9f6a7c7822d2.ngrok.io
- Start the backend server:
- Goto the Settings Page
- On that page, Search for
Manage your Template messaging settings
and enable it - On same page, Search for
Callback URL / Link your Bot
- Enter your callback URL that ngrok gave you, add:
/gupshup
to the end. Something like:https://9f6a7c7822d2.ngrok.io/gupshup/
- Click
Set
. It should give you aCallback set successfully
message. If not, check the above steps.
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 glific 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
- User Guide
- Postman API docs
- GraphQL API docs
- Code Documentation
- Recipes - Code smaples for some common use cases in glific.
Thanks to our generous funders over the past few years who have funded this project: