HappyX Framework Documentation

HappyX is a macro-oriented framework that provides several tools for full-stack development:

• Asset Building: Use buildHtml, buildStyle, and buildJs macros to generate web assets.
• Request Modeling: Use the model macro to support JSON, XML, Form-Data, and x-www-form-urlencoded request bodies.
• Routing: Supports powerful path parameters via the pathParams macro.
• Sub-applications: Use the mount macro to mount sub-applications.
• Logging: Enable logging using the -d:debug flag.
• Translation: Enable automatic translation using -d:hpxTranslate or -d:translate flags.

To run the sandbox_api example, which is used in the HappyX website, ensure your environment meets the following requirements:

• Nim: version v2.0.0 or higher.
• HappyX: The #head version (latest development version).
• Libraries: The regex library must be installed.

To start the development server for a HappyX website and enable hot-reloading, use the hpx dev command with the --reload flag. This allows you to see changes in real-time at localhost.

hpx dev --reload

To run the client component of the Chat App example, navigate to the client/src directory and compile the Nim code to JavaScript.

cd client/src
nim js main

To start a new SPA project, use the hpx CLI tool with the --kind SPA flag. You can also include the --path-params flag to enable path parameter support.

hpx create --name spa_project --kind SPA --path-params
cd spa_project

Install the HappyX Python bindings using pip. This package requires Python >= 3.7.x.

pip install happyx

To run the server component of the Chat App example, navigate to the server/src directory and use the Nim compiler with the httpx and debug flags enabled.

cd server/src
nim c -r -d:httpx -d:debug main

To start a new SSR project, use the hpx CLI tool with the --kind SSR flag. The main entry point will be located at src/main.nim within your project directory.

hpx create --name ssr_project --kind SSR
cd ssr_project/src

The examples directory contains several reference implementations demonstrating different application types possible with the HappyX framework:

• Hello, world!: A basic entry-level application.
• TODO App: A functional task management application.
• Nim Website: A complex site implementation (a copy of nim-lang.org).
• Chat App: A full-stack implementation featuring both server-side and client-side logic using HappyX.
• Official HappyX website: A Single Page Application (SPA) built entirely with HappyX.

Install the HappyX NodeJS bindings using npm.

Note: Currently, these bindings only work on Linux. If you are using Windows, you must use WSL (Windows Subsystem for Linux) to run the project.

npm install happyx

For SPA projects, you can use the hpx dev command to start a development server with hot code reloading enabled.

hpx dev --reload