GETTING_STARTED.md

GETTING_STARTED.md

Welcome to the hexaFn project! This guide will help you set up your environment, build the project, and understand the basics of how to start using or contributing to hexaFn.

---

🔧 Prerequisites

Ensure the following tools are installed:

• Rust
• cargo (comes with Rust)
• git (version control)
• Optional: just, make, or cargo-make for task automation

---

📦 Clone the Repository

git clone https://github.com/hTuneSys/hexaFn.git
cd hexaFn

---

📁 Install Dependencies

hexaFn uses native Rust tooling.

cargo fetch

To install auxiliary tools (if configured):

cargo install cargo-make

---

🚀 Run the Project (Example)

cargo run

For custom environments:

HEXA_ENV=dev HEXA_PORT=4000 cargo run

---

🧪 Run Tests

cargo test

To run specific tests:

cargo test test_function_name

---

✅ Verify Formatting & Linting

Format code using:

cargo fmt

Check for lint errors:

cargo clippy

---

📚 Next Steps

• Check ARCHITECTURE to understand system design
• Use USE_CASES to explore core functionalities
• Review CONTRIBUTING to contribute effectively

---

You're now ready to explore and build with hexaFn. Happy hacking!