📖 HABA-Na-HABA USSD APPLICATION

This is an application designed to connect waste points with vulnerable groups, enabling people to collect food that's about to be wasted for their own use. This application uses Africa's Talking API for USSD functionality and a Rails backend.

Key Features

• Geolocation technology.
• Real-Time Notifications.
• Surplus Food and needs Listings.
• User-Friendly Interface.
• Feedback and Rating System
• Ussd functionality for the app.

Prerequisites

In order to run this project you need:

• Ruby on Rails Environment
• Africa's Talking Account
• Africa's Talking Gem
• Rails Application Setup
• Environment Configuration
• Controller and Routes
• Controller Logic
• Africa's Talking Callback URL
• Ngrok (for Local Development)
• Testing

(back to top)

Tech Stack

Client

• Africas talking

Server

• Ruby on Rails

Database

• PostgreSQL

(back to top)

Setup

Clone this repository to your dist folder:

git@github.com:Ayokunnumi1/zero-hunger-hackathon.git
cd zero-hunger-hackathon

Create a New Rails App

rails new zero-hunger-hackathon
cd zero-hunger-hackathon

Africas talking API

1. Sign Up for Africa's Talking

• Visit Africa's Talking.
• Click on "Sign Up" and create a new account.

2. Verify Your Account

• Check your email for a verification link from Africa's Talking.
• Click the link to verify your account.

3. Login to Your Africa's Talking Account

• Go to Africa's Talking Login.
• Enter your credentials and log in.

4. Create a New Application In the dashboard,

• Navigate to "Sandbox Apps" or "Production Apps".
• Click on "Create a New App".
• Enter a name for your application (e.g., "USSDApp").
• Save your new application.

5. Obtain API Key

• In your application dashboard, find your "API Key".
• Copy the API key for use in your Rails application.

6. Set Up a USSD Channel

• Navigate to "USSD" in the dashboard.
• Click on "Create Channel" or "Add Service Code".
• Follow the prompts to set up a USSD code (e.g., *123#).
• Link the USSD code to your application.

7. Configure Callback URL

• Set the "Callback URL" to point to your Rails application's endpoint (e.g., https://yourdomain.com/ussd). Use Ngrok for local development (e.g., https://your-ngrok-subdomain.ngrok.io/ussd).

8. Add Africa's Talking Credentials to Rails

Ngrok

• Go to ngrok and sign up for a free account or login if you already have one.
• To install ngrok, visit the download page.
• To connect your account to ngrok run ngrok authtoken <your authtoken> and replace with your authtoken.
• We will get back to ngrok later, let's first setup our rails app.

Ruby gems

• gem 'rack-cors'
• gem 'africastalking'```.
• Add the following gems to your gemfile and run bundle install.

(back to top)

🚀 Video Demo

• Live Video Link

(back to top)

Usage

Use this project in the sandbox demo of Africastalking ussd API.

👥 Authors

👤 Ayokunnumi Omololu

• GitHub: @Ayokunnumi1
• Twitter: @Ayokunnumi
• LinkedIn: @Ayokunnumi

👤 Austin Obimbo

• GitHub: @Obimbo07
• Twitter: @Austine
• LinkedIn: LinkedIn

👤 Md Mahadi Hasan Rifat

• GitHub: (https://github.com/Rifat8080)
• Twitter: (https://twitter.com/mdmahadirifat98)
• LinkedIn: (https://www.linkedin.com/in/md-mahadi-hasan-rifat-8b7851265/)

👤 Al Amin Khan Shakil

• GitHub: Al Amin Khan Shakil
• Twitter: Al Amin Khan Shakil
• LinkedIn: Al Amin Khan Shakil

(back to top)

🔭 Future Features

• Utilize iot devices for food delivery
• Feedback functionality.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

You are welcome to support this project by giving leaving a star on the project.

🙏 Acknowledgments

Acknowledgements to Tech to the rescue team and haba na haba for giving us a platform to code to fight food hunger.

(back to top)

📝 License

This project is MIT licensed.

(back to top)