clails

A web framework inspired by Ruby on Rails, built with Common Lisp.

Features

• MVC Architecture - Model-View-Controller design pattern
• RESTful Routing - Rails-like routing with automatic REST resource generation
• Active Record Pattern - Intuitive database operations with ORM
• Database Migrations - Version control for database schema
• Multiple Database Support - SQLite3, MySQL, PostgreSQL
• Task System - Custom task definition and execution with dependency management
• Template Engine - Built-in templating for views
• Scaffolding - Rapid prototyping with code generation
• Docker Support - Ready-to-use Docker development environment
• Swank Integration - Remote debugging via REPL

Requirements

• Roswell (Common Lisp implementation manager)
• SBCL (Steel Bank Common Lisp)

Installation

Installing Roswell

# macOS (Homebrew)
brew install roswell

# Linux
# See https://github.com/roswell/roswell/wiki/Installation

Installing Required Libraries

ros install fukamachi/cl-dbi
ros install tamurashingo/cl-dbi-connection-pool
ros install tamurashingo/cl-batis
ros install tamurashingo/getcmd

Installing clails

ros install tamurashingo/clails

To specify a specific branch or tag:

# branch
ros install tamurashingo/clails/release/0.0.2

# tag
ros install tamurashingo/clails/v0.0.2

Verify Installation

clails --help

Quick Start

Create a New Project

clails new todoapp
cd todoapp

Docker Development (Recommended)

Build and start the Docker environment:

make build
make up

Create database and run migrations:

make db.create
make db.migrate

Available Make commands:

• make build - Build Docker image
• make up - Start containers
• make down - Stop containers
• make console - Open shell in container
• make db.create - Create database
• make db.migrate - Run migrations

Local Development

Create database:

clails db:create

Run migrations:

clails db:migrate

Start server:

clails server

Visit http://localhost:5000/ to see the welcome page:

Documentation

Comprehensive guides for developing with clails:

• QuickStart (日本語) - Build your first TODO application
• Command Guide (日本語) - CLI commands reference
• Model Guide (日本語) - Database operations, queries, transactions, and pessimistic locking
• Logging Guide (日本語) - Flexible logging system with hierarchical loggers
• Task Guide (日本語) - Custom task system with dependency management
• View Guide (日本語) - Template engine and rendering (coming soon)
• Controller Guide (日本語) - Request handling and routing (coming soon)
• Environment Guide (日本語) - Configuration management (coming soon)
• Testing Guide (日本語) - Testing framework (coming soon)

---

Copyright 2024-2025 tamura shingo