Phoenix UI v1.1

.env.example

@@ -0,0 +1,9 @@
+# NextJS
+SKIP_NODE_VERSION_CHECK=1
+
+# Turborepo
+TURBO_TEAM=phoenix-protocol
+TURBO_TOKEN=your-token-here
+
+# Build Options
+NODE_ENV=development

.gitignore

@@ -34,4 +34,6 @@ next-env.d.ts
 
 .idea/
 
-.yarn/cache
+.yarn/cache
+
+.turbo

.nvmrc

@@ -0,0 +1 @@
+20.14.0

README.md

@@ -4,7 +4,7 @@
 
 # Phoenix Frontend
 
-Phoenix Frontend is built with TypeScript and leverages yarn workspaces for package management. You'll find multiple packages in the `/packages` directory, each serving a unique function in the overall application ecosystem.
+Phoenix Frontend is built with TypeScript and leverages yarn workspaces for package management. You'll find multiple packages in the `/packages` directory, each serving a unique function in the overall application ecosystem. The project is optimized with Turborepo for efficient monorepo management.
 
 ## Packages
 
@@ -22,21 +22,100 @@ Housing a range of utility and helper functions, the `Utils` package offers a on
 
 ### [Core](https://github.com/Phoenix-Protocol-Group/phoenix-frontend/tree/main/packages/core)
 
-As the heart of the application, the `Core` package orchestrates the UI, state management, and utility functions. It's built on Next.js and serves as the primary entry point, setting the architectural groundwork and facilitating inter-package interactions.
+As the heart of the application, the `Core` package orchestrates the UI, state management, and utility functions. It's built on Next.js 15 and serves as the primary entry point, setting the architectural groundwork and facilitating inter-package interactions.
 
 ### [Contracts](https://github.com/Phoenix-Protocol-Group/phoenix-frontend/tree/main/packages/contracts)
 
 The `Contracts` package provides generated contract classes and associated types, created through Soroban bindings. For more information, refer to [Soroban's documentation](https://soroban.stellar.org/docs/getting-started/create-an-app#generate-an-npm-package-for-the-hello-world-contract).
 
+### [Types](https://github.com/Phoenix-Protocol-Group/phoenix-frontend/tree/main/packages/types)
+
+The `Types` package contains TypeScript type definitions used throughout the Phoenix Frontend ecosystem, ensuring type consistency across all packages.
+
+### [Strategies](https://github.com/Phoenix-Protocol-Group/phoenix-frontend/tree/main/packages/strategies)
+
+The `Strategies` package serves as a strategy provider registry for the Phoenix DeFi ecosystem, offering modular and extensible strategy implementations.
+
 ## Quick Start
 
-1. Clone the repo locally.
-2. Make sure Node.js and yarn are installed.
-3. Cd into the project root.
-4. Run `yarn install`.
-5. Navigate to the package you're interested in under `/packages`.
-6. Check the package-specific readme for setup and usage instructions.
+### Setup Script
+
+The easiest way to get started is to use the provided setup script:
+
+```bash
+./setup.sh
+```
+
+This script will:
+
+1. Check for the correct Node.js version
+2. Create a local environment file
+3. Install dependencies
+4. Build the required packages
+
+### Development with Turborepo
+
+This project uses Turborepo for efficient monorepo management. It optimizes builds, provides incremental builds, and manages dependencies between packages.
+
+```bash
+# Install dependencies
+yarn install
+
+# Start development with watch mode for all packages
+yarn dev
+
+# Run only the core app (Next.js)
+yarn dev:core
+
+# Run experimental features (if available)
+yarn dev:experimental
+
+# Run only the UI package development
+yarn dev:ui
+
+# Build all packages
+yarn build
+
+# Build specific packages
+yarn build:core       # Build the core Next.js app
+yarn build:contracts  # Build the contracts package
+yarn build:state      # Build the state package
+yarn build:ui         # Build the UI package
+yarn build:utils      # Build the utils package
+yarn build:types      # Build the types package
+yarn build:strat      # Build the strategies package
+
+# Run Storybook for the UI package
+yarn storybook
+```
+
+#### Understanding the Development Process
+
+When you run `yarn dev`, Turborepo will:
+
+1. Build all necessary dependencies in the correct order
+2. Start watch mode for all packages, rebuilding them when files change
+3. Start the Next.js development server for the core package
+
+This means you can edit files in any package, and changes will automatically be reflected in the running application without manual rebuilds.
+
+## Project Structure
+
+- `/packages/core` - Next.js application (main entry point)
+- `/packages/ui` - UI component library based on Material UI
+- `/packages/state` - State management with Zustand
+- `/packages/utils` - Utility functions
+- `/packages/types` - TypeScript type definitions
+- `/packages/contracts` - Generated Soroban contract bindings
+- `/packages/strategies` - Strategy provider registry for Phoenix DeFi
+- `/schemas` - JSON schemas for project configuration
+
+## Requirements
+
+- Node.js (version specified in .nvmrc)
+- Yarn package manager
+- Git
 
 ## Reach Out
 
-Questions, feedback, or suggestions? Feel free to connect with our dev team. We value your input!
+Questions, feedback, or suggestions? Feel free to connect with our dev team via [GitHub Issues](https://github.com/Phoenix-Protocol-Group/phoenix-frontend/issues). We value your input!

package.json

@@ -3,16 +3,20 @@
   "description": "The Phoenix Frontend is a TypeScript-based web application utilizing yarn workspaces. It includes a UI kit (MUI-based), state management, utility functions, and a core package for seamless integration. It's written to use it with phoenix-contracts on Stellar's soroban platform.",
   "version": "0.0.1",
   "scripts": {
-    "test": "yarn workspace @phoenix-protocol/utils run test --passWithNoTests",
-    "build": "yarn workspace @phoenix-protocol/types run build && yarn workspace @phoenix-protocol/utils run build && yarn workspace @phoenix-protocol/contracts run build && yarn workspace @phoenix-protocol/state run build && yarn workspace @phoenix-protocol/ui run build && yarn workspace @phoenix-protocol/core run build",
+    "test": "turbo run test",
+    "build": "turbo run build",
     "storybook": "yarn workspace @phoenix-protocol/ui storybook",
-    "dev": "yarn workspace @phoenix-protocol/core dev",
-    "build:core": "yarn workspace @phoenix-protocol/core build",
-    "build:contracts": "yarn workspace @phoenix-protocol/contracts build",
-    "build:state": "yarn workspace @phoenix-protocol/state build",
-    "build:ui": "yarn workspace @phoenix-protocol/ui build",
-    "build:utils": "yarn workspace @phoenix-protocol/utils build",
-    "build:types": "yarn workspace @phoenix-protocol/types build"
+    "dev": "turbo run dev",
+    "dev:core": "turbo run dev --filter=@phoenix-protocol/core",
+    "dev:ui": "turbo run dev --filter=@phoenix-protocol/ui",
+    "dev:experimental": "yarn workspace @phoenix-protocol/core dev:experimental",
+    "build:core": "turbo run build --filter=@phoenix-protocol/core",
+    "build:contracts": "turbo run build --filter=@phoenix-protocol/contracts",
+    "build:state": "turbo run build --filter=@phoenix-protocol/state",
+    "build:ui": "turbo run build --filter=@phoenix-protocol/ui",
+    "build:utils": "turbo run build --filter=@phoenix-protocol/utils",
+    "build:types": "turbo run build --filter=@phoenix-protocol/types",
+    "build:strat": "turbo run build --filter=@phoenix-protocol/strategies"
   },
   "repository": {
     "type": "git",
@@ -36,14 +40,20 @@
   "devDependencies": {
     "@tsconfig/recommended": "^1.0.2",
     "@types/jest": "^29.5.2",
-    "jest": "^29.5.0"
+    "concurrently": "^9.1.2",
+    "jest": "^29.5.0",
+    "turbo": "^2.5.3"
   },
   "packageManager": "[email protected]",
   "dependencies": {
+    "@emotion/react": "^11.14.0",
+    "@emotion/styled": "^11.14.0",
     "@stellar/stellar-sdk": "^13.1.0",
+    "@storybook/react-webpack5": "^8.6.9",
     "@walletconnect/modal": "^2.6.2",
     "@walletconnect/sign-client": "^2.13.1",
     "@walletconnect/types": "^2.13.1",
+    "framer-motion": "^12.6.0",
     "next": "15.0.3"
   }
 }

packages/contracts/package.json

@@ -11,8 +11,9 @@
     "buffer": "6.0.3"
   },
   "scripts": {
-    "test": "tsc && jest",
-    "build": "tsc"
+    "test": "echo \"Error: no test specified\" && exit 0",
+    "build": "tsc",
+    "dev": "tsc --watch"
   },
   "main": "build/index.js",
   "types": "build/index.d.ts",

packages/contracts/readme.md

@@ -1,19 +1,30 @@
 # Contracts Package for Phoenix Frontend
 
-The `Contracts` package is part of the larger Phoenix Frontend ecosystem and serves as a repository for generated contract classes and their associated types. This package is generated using [Soroban bindings](https://soroban.stellar.org/docs/getting-started/create-an-app#generate-an-npm-package-for-the-hello-world-contract).
+The `Contracts` package is part of the larger Phoenix Frontend ecosystem and serves as a repository for generated contract classes and their associated types. This package is generated using [Soroban bindings](https://soroban.stellar.org/docs/getting-started/create-an-app#generate-an-npm-package-for-the-hello-world-contract) for seamless integration with the Stellar Soroban platform.
 
 ## Features
 
-- Generated contract classes for seamless integration with blockchain platforms.
-- Types associated with each contract class for type safety.
-- Soroban bindings for compatibility and extendibility.
+- Generated contract classes for Phoenix Protocol contracts
+- TypeScript types for contract interactions
+- Soroban bindings for the Stellar blockchain
+- Predefined contract interaction methods
+- Helper functions for interacting with Phoenix protocol
+
+## Included Contracts
+
+- `phoenix-factory` - Factory contract for creating and managing token pairs
+- `phoenix-multihop` - Contract for multi-hop swaps between different token pairs
+- `phoenix-pair` - Liquidity pair contract for token swaps
+- `phoenix-stake` - Staking contract for liquidity provider rewards
+- `phoenix-vesting` - Vesting contract for token distribution
+- `soroban-token` - Token contract implementation for Soroban
 
 ## Installation
 
-Navigate to the `Contracts` directory within the `/packages` directory of the main Phoenix Frontend project:
+Navigate to the root directory of the Phoenix Frontend project:
 
 ```bash
-cd path-to-your-project/packages/Contracts
+cd /path/to/phoenix/frontend
 ```
 
 Run the following command to install all dependencies:
@@ -22,16 +33,49 @@ Run the following command to install all dependencies:
 yarn install
 ```
 
+Build the contracts package:
+
+```bash
+yarn build:contracts
+```
+
 ## Usage
 
-After installation, you can import the contract classes and types into your project as needed.
+After installation, you can import the contract classes and types into your project as needed:
 
 ```typescript
-import { ContractClassName } from '@phoenix-frontend/contracts';
+import {
+  PhoenixPairClient,
+  PhoenixFactoryClient,
+  PhoenixMultihopClient,
+} from "@phoenix-protocol/contracts";
+
+// Initialize a contract client
+const pairClient = new PhoenixPairClient({
+  contractId: "your_contract_id",
+  networkPassphrase: "your_network_passphrase",
+  rpcUrl: "your_rpc_url",
+});
+
+// Interact with the contract
+const poolInfo = await pairClient.getPoolInfo();
 ```
 
-Refer to the main Phoenix Frontend readme for guidance on how this package interacts with the other packages in the ecosystem.
+## Fetching PHO Token
+
+This package also includes a utility for fetching PHO tokens from the faucet:
+
+```typescript
+import { fetchPho } from "@phoenix-protocol/contracts";
+
+// Fetch PHO tokens to your wallet
+await fetchPho(walletPublicKey);
+```
 
 ## Additional Resources
 
-For more information on generating contract classes and types, refer to the [Soroban documentation](https://soroban.stellar.org/docs/getting-started/create-an-app#generate-an-npm-package-for-the-hello-world-contract).
+For more information on Soroban contracts and Stellar development:
+
+- [Soroban Documentation](https://soroban.stellar.org/docs)
+- [Stellar Developers Guide](https://developers.stellar.org/docs)
+- [Phoenix Protocol Documentation](https://docs.phoenix-protocol.io)