GiveCup: Building Communities Around Causes 🌍

A gamified web3 based mobile app that makes donations secure, transparent, and rewarding.

Table of Contents

• About
• Preview
• Features
• Getting Started
  • Prerequisites
  • Clone the Repository
  • Install Dependencies
  • Environment Variables
  • Usage
  • Customizing & Contributing

🖼 Preview

📜 About

GiveCup revolutionizes the way charitable donations are made, by integrating the benefits of the blockchain, gamification, and community-building. Developed by a trio of high school students & Web3 enthusiasts for XDay /hackathon, GiveCup aims to ensure every donation counts, while providing a rewarding and engaging user experience.

🚀 Features

• Gamified Giving: Transform your charitable donations into a game-like experience. Donate, level up, and unlock unique rewards.
• Blockchain Transparency: Every transaction is securely documented on the MultiversX blockchain, ensuring a traceable ledger of your contributions.
• Security First: Support verified NGOs and be confident that your contributions are safeguarded against fraud.
• Dynamic NFT: Your entrance ticket is a customizable NFT cup. Decorate it, enhance its value, and then donate its worth to an organization you're passionate about.
• Rankings & In-app Updates: Keep track of your progress and receive regular updates within the app.
• Simple Donation Process: Choose an NGO, donate the value of your NFT cup, earn XP, and watch your contributions make a difference.

🛠 Getting Started

Prerequisites

• Ensure you have Node.js and Expo CLI installed.
• Familiarity with TypeScript and React Native will be helpful.

Clone the repository

git clone https://github.com/GiveCup/givecup.git
cd givecup

Install Dependencies

Using npm:

npm install

or using yarn:

yarn

Environment Variables

Before running the app, make sure to set up the necessary environment variables. Create a .env file in the root directory of your project and add the following:

EXPO_PUBLIC_SUPABASE_URL=YOUR_SUPABASE_URL
EXPO_PUBLIC_SUPABASE_ANON_KEY=YOUR_ANON_KEY

Replace YOUR_SUPABASE_URL and YOUR_ANON_KEY with the appropriate values.

📖 Usage

Running the project First, make sure you're in the project directory. Then, start the Expo development server:

expo start

This will open a new page in your default browser with a QR code. Scan this code with the Expo Go app on your Android or iOS device to see the app in action!

Customizing & Contributing

For developers who wish to customize or contribute to the project, ensure you're familiar with:

• React Native
• Expo
• TypeScript
• Supabase
• React Native XPortal
• TailwindCSS

Feel free to create a pull request or raise an issue for any suggestions, improvements, or bugs!