Skip to content

development.md

Latest commit

 

History

History
51 lines (33 loc) · 1.2 KB

development.md

File metadata and controls

51 lines (33 loc) · 1.2 KB

Development Guide

Platform-Specific Prerequisites

Windows Users

Windows users need to install WSL (Windows Subsystem for Linux) first. Please follow the WSL Installation Guide before proceeding.

macOS Users

macOS users need to install Homebrew first. Please follow the Homebrew Installation Guide before proceeding.

Prerequisites

Ensure you have Node.js and LuaRocks installed on your system. You can use the following command to set up your environment automatically:

make setup

Or follow the instructions in the respective guides:

Installing Project Dependencies

To install the project's dependencies, simply run:

make install

Building the Project

To build the project, use:

make build

Running Unit Tests

To run the unit test suite, execute:

make test

This project uses Busted for testing. All test files should:

  • Be placed in the spec directory
  • Have a filename ending in _spec.lua
  • Use BDD-style describe and it blocks