Skip to content

ProjectTides/tides

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Project Tides

Tides is a two-way chat platform between NGOs and their impact community that is built using WhatsApp API. The platform allows NGOs to chat with each of their beneficiaries and help them to uplift their lives. NGOs can work in various sectors such as healthcare, education, women empowerment, and more… so for education, an NGO can chat with a beneficiary to help them with the admission process, share study material or learn other ways they can intervene.

About the prototype

This prototype repository covers the various technologies, connect the dots and test a working model of the platform. A most basic use case of the application is used to build the prototype. It follows like this:

  1. A beneficiary will be able to message an NGO user via WhatsApp.
  2. The message will be visible on the platform.
  3. It will get labeled with relevant keywords.
  4. A basic response will be suggested too.
  5. The NPO user will use the suggestion from the system to form a response and then send it to the beneficiary.

Status

CI License

Installation

Prerequisite:

  1. Elixir 1.6 or later
  2. Erlang 20 or later
  3. Phoenix

Setup Guide

  • Duplicate the file dev.exs.example and name it as dev.exs.

Dockerized project setup

  • docker-compose config Check if docker config and env variables are set properly.
  • docker-compose up -d Start the container.

Non-dockerized project setup

  • Create your application database manually and update the database variables.
  • Run mix setup.
  • Run mix phx.server

Now you can visit localhost:4000 from your browser.

Documentation

ProjectTides's documentation is built with Jekyll and publicly hosted on GitHub Pages at https://projecttides.github.io/tides/.

Resources

  1. Elixir
    1. Elixir basics
  2. CI
    1. Phoenix github action for CI
  3. CD
    1. Dockerized production env
    2. Deploying Docker Containers Using an AWS CodePipeline

Contributing

We appreciate feedback and contribution to this repo! Before you get started, please see the following:

Support + Feedback

Include information on how to get support. Consider adding:

License

This project is covered under The GNU General Public License v3.0.

About

A prototype for a two-way communication platform between NGOs and beneficiaries using WhatsApp APIs. https://projecttides.github.io/tides

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published