Skip to content

Latest commit

 

History

History
178 lines (129 loc) · 5.35 KB

README.md

File metadata and controls

178 lines (129 loc) · 5.35 KB
Raw

offline-pay-with-crypto

Enable anyone to accept CELO and other crypto via an embed on Mobile, Web and through a processing Agent
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

  • npm 
    npm install npm@latest -g

Installation

  1. Clone the repo 
    git clone https://github.com/Chimoney/offline-pay-with-crypto.git
  2. Install NPM packages 
    npm install

(back to top)

Usage

This project has four packages found in the /packages directory. Each package has a readme

For full details of how to use, please refer to the Documentation

(back to top)

Roadmap

  • Setup
  • Accept Celo
  • Accept cUSD
  • Enable payment by integrating a Payment widget
  • Enable payment by integrating in a React Apps
  • Enable payment from No-code Merchant app
  • Pay with Valora on Web and Mobile
  • Pay with Celo Web Wallet
  • Pay with Metamask
  • Pay with Walletconnect
  • Backend service to watch for transactions
  • Pay through offline Agent by emailing payment request to Agent

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.md for more information.

(back to top)

Contact

Project Link: https://github.com/Chimoney/offline-pay-with-crypto

(back to top)

Acknowledgments

  • Celo for funding this project

(back to top)

MIT PRs welcome!