Saite 项目教程

1. 项目目录结构及介绍

Saite 项目的目录结构如下：

saite/
├── CHANGELOG.md
├── LICENSE
├── README.md
├── project.clj
├── doc/
│   └── examples/
├── resources/
│   └── public/
├── src/

目录介绍

• CHANGELOG.md: 记录项目的更新日志。
• LICENSE: 项目的开源许可证，Saite 使用 MIT 许可证。
• README.md: 项目的介绍文档，包含项目的概述、安装和使用说明。
• project.clj: 项目的配置文件，定义了项目的依赖、版本等信息。
• doc/: 包含项目的文档和示例。
  • examples/: 存放示例代码和文档。
• resources/: 存放项目的静态资源文件。
  • public/: 存放公开的静态资源文件。
• src/: 存放项目的源代码。

2. 项目启动文件介绍

Saite 项目的启动文件位于 src/ 目录下。主要的启动文件是 src/aerial/saite/core.cljs，该文件包含了启动服务器的代码。

启动代码示例

(ns aerial.saite.examples
  (:require [aerial.saite.core :as saite]))

(saite/start 3000)  ; 启动服务器，监听端口 3000

停止服务器

(saite/stop)  ; 停止服务器

3. 项目配置文件介绍

Saite 项目的主要配置文件是 project.clj，该文件使用 Leiningen 作为构建工具。

project.clj 配置示例

(defproject aerial/saite "1.1.0"
  :description "Interactive document creation for exploratory graphics and visualizations"
  :url "https://github.com/jsa-aerial/saite"
  :license {:name "MIT License"
            :url "https://opensource.org/licenses/MIT"}
  :dependencies [[org.clojure/clojure "1.10.1"]
                 [org.clojure/clojurescript "1.10.597"]
                 ...]
  :plugins [[lein-cljsbuild "1.1.7"]
            ...]
  :cljsbuild {:builds [{:id "dev"
                        :source-paths ["src"]
                        :compiler {:output-to "resources/public/js/main.js"
                                   :optimizations :none}}]}
  :main aerial.saite.core)

配置文件说明

• :description: 项目的描述信息。
• :url: 项目的 GitHub 仓库地址。
• :license: 项目的许可证信息。
• :dependencies: 项目的依赖库。
• :plugins: 项目的插件配置。
• :cljsbuild: ClojureScript 的构建配置。
• :main: 指定项目的入口文件。

通过以上配置，可以轻松地启动和配置 Saite 项目。