docs: add readme

Author: dante4rt

.DS_Store

@@ -0,0 +1,4 @@
+PRIVATE_KEY=0x
+RPC_URL="halorei"
+ETHERSCAN_API_KEY=
+VERIFIER_URL=

.env.example

@@ -0,0 +1,49 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+env:
+  FOUNDRY_PROFILE: ci
+
+jobs:
+  check:
+    strategy:
+      fail-fast: true
+      matrix:
+        version: [1]
+
+    name: Foundry project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+
+      - name: Install Deps
+        run: |
+          forge install https://github.com/foundry-rs/forge-std https://github.com/OpenZeppelin/openzeppelin-contracts
+
+      - name: Show Forge version
+        run: |
+          forge --version
+
+      - name: Run Forge fmt
+        run: |
+          forge fmt --check
+        id: fmt
+
+      - name: Run Forge build
+        run: |
+          forge build --sizes
+        id: build
+
+      - name: Run Forge tests
+        run: |
+          forge test -vvv
+        id: test

.github/workflows/test.yml

@@ -0,0 +1,18 @@
+# Compiler files
+cache/
+out/
+
+# Ignores development broadcast logs
+!/broadcast
+/broadcast/*/31337/
+/broadcast/**/dry-run/
+
+# Docs
+docs/
+
+# Dotenv file
+.env
+
+lib/
+node_modules/
+broadcast/

.gitignore

@@ -0,0 +1,6 @@
+[submodule "lib/forge-std"]
+	path = lib/forge-std
+	url = https://github.com/foundry-rs/forge-std
+[submodule "lib/openzeppelin-contracts"]
+	path = lib/openzeppelin-contracts
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts

.gitmodules

@@ -0,0 +1,49 @@
+.PHONY: test
+test:
+	forge test
+
+.PHONY: debug
+debug:
+	forge test -vv
+
+.PHONY: trace
+trace:
+	forge test -vvvv
+
+.PHONY: coverage
+coverage:
+	forge coverage
+
+.PHONY: deploy
+deploy:
+	set +a; \
+	source .env; \
+	set -a; \
+	forge script \
+	script/SugarDonation.s.sol:DeploySugarDonation \
+	--rpc-url $$RPC_URL \
+	--private-key $$PRIVATE_KEY \
+	--broadcast \
+	--verify \
+	--etherscan-api-key $$ETHERSCAN_API_KEY
+
+.PHONY: deploy-bs
+deploy-bs:
+	set +a; \
+	source .env; \
+	set -a; \
+	forge script \
+	script/SugarDonation.s.sol:DeploySugarDonation \
+	--rpc-url $$RPC_URL \
+	--private-key $$PRIVATE_KEY \
+	--broadcast \
+	--optimize \
+	--optimizer-runs 100 \
+	--skip-simulation \
+	--verify \
+	--verifier-url https://sepolia-blockscout.lisk.com/api \
+	--verifier blockscout
+
+.PHONY: install
+install:
+	forge install foundry-rs/forge-std OpenZeppelin/openzeppelin-contracts --no-commit

Makefile

@@ -0,0 +1,48 @@
+# Sugar Contracts
+
+Smart contracts for Sugar, a Web3-native platform empowering streamers and communities to connect, collaborate, and monetize transparently.
+
+## ⚙️ Tech Stack
+
+- **Foundry** – Fast, modular testing and deployment framework for Solidity  
+- **Forge Std** – Testing utilities and cheatcodes  
+- **OpenZeppelin Contracts** – Secure, audited smart contract libraries
+
+## 🔨 Setup
+
+1. Install Foundry:
+
+   ```bash
+   curl -L https://foundry.paradigm.xyz | bash
+   foundryup
+    ````
+
+1. Install dependencies:
+
+   ```bash
+   npm install
+   ```
+
+## 🚀 Scripts
+
+- Run tests:
+
+  ```bash
+  forge test
+  ```
+
+- Run a script (e.g., deploy):
+
+  ```bash
+  forge script script/SugarDonation.s.sol --rpc-url $RPC_URL --private-key $PRIVATE_KEY --broadcast
+  ```
+
+## 👥 Team
+
+Built with ❤️ by:
+
+- **Rei Yan**
+- **Jo**
+- **Rama**
+
+Part of the Sugar project: [github.com/sugar-space](https://github.com/sugar-space)

README.md

@@ -0,0 +1,7 @@
+[profile.default]
+src = "src"
+out = "out"
+libs = ["lib"]
+solc = '0.8.20'
+
+# See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options

foundry.toml

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "@openzeppelin/contracts": "^5.2.0"
+  }
+}