emmaodia / CeloRemit

Celo virtual hackathon submission

CeloRemit

An awesome lightweight P2P payments and escrow wallet with Web3Auth integration!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

CeloRemit is a micro P2P custodial payment wallet that enables Africans to inter-transact digitaly by using a simple top up voucher. Currently 60% of Africa relay on cash and only 70% have acive Bank acounts. Making it increasingly difficult to move money around.

Here's why:

• CeloRemit, is secure and payments are immediate and seamless, using the virtual currency.
• The escrow payment option provides a secure enviroment for payments when paying for future goods or services
• Immediate access to all your CeloRemit contacts.

CeloRemit eliminates the need for a bank accounts, and the use of cash in the Market place as well as daily use of cash.

(back to top)

Built With

• Celo
• Tatum
• Ionic
• Angular
• Python
• Web3Auth
• Android Studio
• Ngrok

(back to top)

Notice

1. This project is not audited and should not be used in a production environment.
2. The project was build on Windows and has not been tested on any Linux distro, but it should run since the tools used are cross platform.

Getting Started

Follow the steps below on how to run the project.

Prerequisites

Please install the below required software in order to run the project.

• NodeJs NodeJS

• npm

  npm install npm@latest -g

• angular

  npm install -g @angular/cli

• ionic

    npm install -g @ionic/cli

• Install Python Python Python

• Install Android Studio Android Studio

• Physical Android device (access to camera will be required)

Installation

NOTE: Please request CLIENT ID and CLIENT SECRET in order to test with the Web3Auth (Default values provided in app.component.ts file).

1. Get a free Tatum API Key at Tatum
2. Clone the repo

   git clone https://github.com/IKalonji2/CeloRemit.git

3. cd into the project and run the below command to install the requied Python modules

   cd CeloRemit
   pip install -r requirements.txt

4. cd into the Backend folder and run the server. (KEEP THE SERVER RUNNING)

   cd Backend
   python app.py

5. Take note of the Tunnel URL in the terminal output, we'll use that for our server endpoint. Example:

* Tunnel URL: http://3d5d-197-184-183-154.ngrok.io -(COPY THIS)
* Serving Flask app 'app' (lazy loading)
* Environment: production
  WARNING: This is a development server. Do not use it in a production deployment.
  Use a production WSGI server instead.
* Debug mode: off
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

6. cd into the Ionic frontend install dependecies then paste your Tunnel URL as well as the Tatum API key in the environment.ts as well as the enviroment.prod.ts files, Example:

cd ..
cd MobileDapp
npm install

Then enter the details into the environment.ts as well as the enviroment.prod.ts file, Example.

export const environment = {
production: false,
urlLocal: "ENTER_URL_HERE",
urlDeployed: "ENTER_URL_HERE",
API_KEY: "ENTER_API_KEY_HERE"
};

7. Now, we can build the frontend with Ionic and create an APK with Android Studio. In the terminal run:

ionic capacitor build android

Android Studio should open automatically once the build is complete. If not open the Ionic/Frontendandroid folder in Android Studio.

8. Finally, use one of the two options to run the app:

• Option 1: In Android Studio, click on the build tab in the navigation bar and select 'Generate APK'. Complete the steps and navigate to the folder where the APK was generated. Send the APK to your Android device and install.
• Option 2: Connect an Android device to your PC and select your device under the devices section of the navigation bar, then run the app.

(back to top)

Usage

Video Demo

Please refer to the Documentation

(back to top)

Roadmap

• Add Card payments
• Add Voucher provider
• Add App security
• Add backend hosting
• Multi-language Support
  • Swahili
  • Zulu
  • Lingala

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Issa Kalonji - @ISSDawg - [e-mail]

Project Link: https://github.com/IKalonji2/CeloRemit

(back to top)

Acknowledgments

• Web3Auth
• Tatum
• Celo

(back to top)