Development Guide

Project Setup

  1. Clone the Repository:bash

    git clone https://github.com/Blockchain1Royale/OMNIFLUX-ALPHA.git
    cd OMNIFLUX-ALPHA
  2. Install Dependencies:bash

    npm install
  3. Set Up Environment Variables:bash

    cp .env.example .env
    nano .env  # Add your keys

Development Workflow

  1. Start the Server:bash

    node server.js
  2. Run the CLI:bash

    node packages/cli/interactive.cjs
  3. Run Tests:bash

    npm test

Best Practices

  • Modular Design: Follow the modular architecture for maintainability.

  • Testing: Write tests for all new functionality.

  • Documentation: Document APIs and provide usage examples.

  • Error Handling: Implement robust error handling and validation.

  • Logging: Use structured logging for debugging and monitoring.


Troubleshooting

  • Server Fails to Start: Ensure port 8052 is free and dependencies are installed (npm install).

  • Connection Errors: Verify the server is running (curl http://localhost:8052/health).

  • Solana RPC Errors: Check your SOLANA_RPC_URL in .env and ensure it's valid.

  • Python Wrapper Issues: Ensure the server is running and the package is installed correctly (pip install -e .).

Last updated