- AI-Powered Trading - Machine learning-driven trading strategies
- Vault Management - Automated yield optimization and risk management
- Portfolio Analytics - Real-time tracking and performance metrics
- Secure Authentication - Web3 wallet integration with Privy
- Responsive Design - Optimized for all devices
- Frontend: React 18, TypeScript, Vite
- Styling: Tailwind CSS, Shadcn/ui
- Web3: Wagmi, Viem, Privy
- State Management: React Query, Context API
- Testing: Jest, React Testing Library
Before you begin, ensure you have the following installed:
- Node.js (v18 or higher)
- Package Manager (pnpm recommended)
npm install -g pnpm
- Git (for version control)
- Web3 Wallet (MetaMask, Coinbase Wallet, etc.)
-
Clone the repository
git clone https://github.com/operari-xyz/Neura-frontend.git cd Neura-frontend -
Install dependencies
# Using pnpm (recommended) pnpm install # Alternative: using npm npm install # Alternative: using yarn yarn install
-
Environment Configuration
- Copy the example environment file:
cp .env.example .env
- Update the
.envfile with your configuration:# Required Environment Variables VITE_PRIVY_APP_ID=your_privy_app_id VITE_QUICKNODE_RPC_URL=your_quicknode_rpc_url # Optional Configuration VITE_ENVIRONMENT=development VITE_APP_VERSION=1.0.0
- Copy the example environment file:
-
Start Development Server
# Start development server pnpm run devThe application will be available at
http://localhost:8080 -
Building for Production
# Build for production pnpm run build # Preview production build pnpm run preview
src/
βββ components/ # Reusable UI components
β βββ ui/ # Shadcn/ui components
β βββ shared/ # Custom shared components
βββ hooks/ # Custom React hooks
βββ lib/ # Utility functions and configurations
βββ pages/ # Page components
βββ styles/ # Global styles and theme
βββ types/ # TypeScript type definitions
- Frontend Framework: React 18 with TypeScript
- Build Tool: Vite
- Styling: Tailwind CSS with CSS Modules
- State Management:
- React Query for server state
- Context API for global state
- Local state with React hooks
- Web3:
- Wagmi for Ethereum interactions
- Viem for type-safe Web3
- Privy for authentication
- UI Components:
- Shadcn/ui for accessible components
- Radix UI primitives
- Framer Motion for animations
| Network | Type | Status |
|---|---|---|
| Ethereum Mainnet | Production | β Live |
| Arbitrum One | Production | β Live |
| Optimism | Production | β Live |
| Base | Beta | π§ Testing |
| Contract | Description | Address |
|---|---|---|
| VaultFactory | Manages vault creation | 0x... |
| AIAgent | Handles trading strategies | 0x... |
| Whitelist | Manages access control | 0x... |
- MetaMask
- Coinbase Wallet
- Rabby
- WalletConnect
- Connection is wallet-driven using Wagmi connectors. The app gates content by wallet connection (
isConnected). - Use the
Connect Walletbutton in the Navbar to initiate a Wagmiconnect()flow. External wallets (e.g., MetaMask, Rabby, Coinbase) are supported; embedded wallets and email/SSO are not. - Disconnect using the
Disconnectbutton in the Navbar, which calls Wagmi'suseDisconnect.
- Build the application
This will create an optimized production build in the
pnpm run build
distdirectory.
- Push your code to a GitHub repository
- Import the repository in Vercel
- Configure environment variables
- Deploy!
- Set up a web server (Nginx/Apache)
- Configure SSL (Let's Encrypt recommended)
- Serve the
distdirectory - Set up proper caching headers
| Variable | Required | Description |
|---|---|---|
VITE_PRIVY_APP_ID |
Yes | Privy App ID for authentication |
VITE_QUICKNODE_RPC_URL |
Yes | QuickNode RPC endpoint |
VITE_ENVIRONMENT |
No | production or development |
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.
- Built with β€οΈ by the Operari team
- Special thanks to our beta testers and community
pnpm run buildThis creates optimized production files in the dist directory.
- Static Hosting: Deploy the
distdirectory to any static hosting service - Docker: A Dockerfile is provided for containerized deployment
- CI/CD: Configure with GitHub Actions or similar for automated deployment
pnpm run testThe test suite includes unit tests and integration tests to ensure application reliability.
Contributions are welcome! Please follow these steps:
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Please ensure your code follows the project's coding standards and includes appropriate tests.
This project is licensed under the MIT License - see the LICENSE file for details.
Neura Frontend | Built with β€οΈ for the DeFi community