Skip to content

Latest commit

 

History

History
81 lines (67 loc) · 4.93 KB

README.md

File metadata and controls

81 lines (67 loc) · 4.93 KB

CrypGo - Accessibility on the GO!

1. Project Overview

CrypGo is a mobile app crafted with React Native, serving as a wallet for the Global-Scale Sustainable Blockchain Fabric ResilientDB. Users can conveniently access their ResilientDB accounts, submit transactions, and view their activity on the go. API calls are seamlessly directed to https://cloud.resilientdb.com/graphql using Postman.

2. Features

  • Create Account: Seamlessly set up your ResDB wallet with CrypGo, making it effortless to join the sustainable blockchain network and securely manage your digital assets.
  • Delete Account: CrypGo offers the flexibility to remove your account when needed, ensuring control over your data and assets, aligning with your privacy and security preferences.
  • Login: Access your ResDB wallet quickly and securely with CrypGo’s user-friendly login feature, guaranteeing a hassle-free entry to your blockchain account.
  • Submit Transactions: Effortlessly initiate and track blockchain transactions from anywhere, empowering you to engage with the ResDB network at your convenience.
  • Transactions Logging: Keep a detailed record of your ResDB activity with CrypGo’s comprehensive transaction logging, helping you monitor your blockchain operations effectively.

3. The Technology Innovation

CrypGo represents significant technological innovation by leveraging React Native to create a mobile iteration of ResVault. This allows users to access their ResDB account seamlessly from their smartphones, irrespective of their preferred platform. API calls facilitated by Postman connect directly to https://cloud.resilientdb.com/graphql, offering a convenient solution for managing digital assets "On the Go."

Technical Objectives:

  1. Secured Ledger on the Go: Enable users to access a secure ledger on their mobile devices, ensuring their digital assets are protected.
  2. Convenience: Offer a convenient and user-friendly interface for users to engage with ResilientDB effortlessly.
  3. Cross-Platform Compatibility: Ensure the mobile app is accessible on both Android and iOS.
  4. Blockchain Integration: Integrate ResilientDB into the mobile app, allowing seamless interaction with the sustainable blockchain fabric.
  5. Multi-User Capability: Enable multiple users to access and manage their accounts on the same device.
  6. Push Notifications: Implement push notifications to keep users updated on their latest transactions and account activity in real time.
  7. Touch ID (Biometric Authentication): Integrate biometric authentication, such as Touch ID, to enhance security and user convenience.

6. The Company and Team

Meet the passionate and dynamic team behind CrypGo:

  • Toniya: The Innovator with boundless enthusiasm.
  • Roshini: The Mastermind with an ironclad determination.
  • Rohan: The All-Knowing Oracle with a glass half empty but filled with ingenious solutions.
  • Shubhada: Our Designer, Developer, and Dangerously talented artist.
  • Manoj Elango: Our Captain and Professional Procrastinator, steering the ship with a steady hand.

Ways to Contribute

1. Code Contributions

  • Fork the repository to your GitHub account.
  • Create a new branch for your feature or bug fix.
  • Make your changes and ensure that they adhere to the project's coding standards.
  • Submit a pull request, explaining the changes you made and the problem you're solving.

2. Bug Reporting

  • If you encounter a bug, open an issue on the GitHub repository.
  • Provide detailed information about the bug, including steps to reproduce it.
  • If possible, include screenshots or code snippets that demonstrate the issue.

3. Feature Requests

  • Suggest new features or improvements by opening an issue.
  • Clearly describe the proposed feature and why it would be beneficial.

4. Documentation

  • Help improve the project's documentation.
  • Correct typos, clarify explanations, or add missing information.

Getting Started

To contribute to CrypGo, follow these steps:

  1. Fork the CrypGo repository to your GitHub account.
  2. Clone the forked repository to your local machine.
    git clone https://github.com/your-username/CrypGo.git
    cd CrypGo
  3. Create a new branch for your contribution.
    git checkout -b feature-or-fix-branch
  4. Make your changes and commit them.
    git add .
    git commit -m "Your commit message"
  5. Push your changes to your GitHub repository.
    git push origin feature-or-fix-branch
  6. Open a pull request on the main CrypGo repository.

Thank You!

Your contributions are valuable and help make CrypGo better for everyone.