Developing

Rust

Prerequisites

• Install Rust using rustup :

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Clone the Repository

git clone https://github.com/0xLazAI/alith.git
cd alith

Build the SDK

To build the Rust SDK, run:

make check

Run Tests

To run the test suite:

make test

Format Code

Ensure your code follows Rust’s formatting standards:

make fmt

Linting

Use Clippy to catch common mistakes and improve code quality:

make clippy

Contributing

• Fork the repository and create a new branch for your changes.
• Submit a pull request with a detailed description of your changes.

Python

Prerequisites

• Install Python  (v3.8 or higher).
• Install Cargo  (for Rust code).

Clone the Repository

git clone https://github.com/0xLazAI/alith.git
cd alith

Set Up a Virtual Environment

Create and activate a virtual environment:

python3 -m venv venv
source venv/bin/activate

Install Maturin

Install maturin to build the Python bindings:

cargo install maturin

Build the SDK

Build the Python SDK:

maturin develop

Run Tests

Run the test suite:

python3 -m pytest

Contributing

• Fork the repository and create a new branch for your changes.
• Submit a pull request with a detailed description of your changes.

Node.js

Prerequisites

• Install Node.js  (v18 or higher).
• Install Cargo  (for Rust code).

Clone the Repository

git clone https://github.com/0xLazAI/alith.git
cd alith

Install Dependencies

Install the required dependencies:

npm install

Build the SDK

To build the Node.js SDK, run:

npm run build

Run Tests

To run the test suite:

npm test

Format Code

Use Prettier to format your code:

npm run format

Contributing

• Fork the repository and create a new branch for your changes.
• Submit a pull request with a detailed description of your changes.

Website

Prerequisites

• Install Node.js  (v18 or higher).
• Install pnpm  (recommended).

Clone the Repository

git clone https://github.com/0xLazAI/alith.git
cd alith/website

Install Dependencies

Install the required dependencies:

pnpm install

Run the Development Server

Start the development server:

pnpm dev

The website will be available at http://localhost:3000.

Build the Website

To build the website for production:

pnpm build

Deploy the Website

Deploy the website to your preferred platform (e.g., GitHub Page, Vercel, Netlify).

Contributing

• Fork the repository and create a new branch for your changes.
• Submit a pull request with a detailed description of your changes.