入门指南

先决条件

• Node.js v18.16.0+
• Docker v20.10.17+ 或 Kubernetes 集群

要构建 CYK 服务器，create-cyk 程序可以选择生成适用于 Docker Compose 或 Kubernetes 集群的资源文件。

Kubernetes 集群可以是云服务，也可以包含在 Docker Desktop 或 Minikube 中...

cyk 命令包括 start 和 stop 子命令，用于启动和停止 CYK 服务器。

新项目也可以与现有的 CYK 服务器关联。

创建一个新项目

• 步骤 1: 选择项目名称

首先，进入您想要创建新文件夹的位置，然后执行 :

npx create-cyk@latest

将显示 :

npx: installed 38 in 11.348s

CykLang - A Full Stack Programming Language

? Project name: › cyk-project

创建的文件夹将与项目名称相同.

• 步骤 2: 使用 Docker 构建 Cyk 服务器

一旦您输入了项目名称或接受了默认项目名称， 请指示是否要配置新的 Cyk 服务器或连接到现有服务器.

✔ Project name: … cyk-project
? Cyk Servers : › - Use arrow-keys. Return to submit.
❯   build local Cyk servers with docker
    build Cyk server with kubernetes resources
    connect to existing Cyk servers

由于这是我们的第一个 Cyk 项目，接受默认选项，将创建两个 Docker 容器。一个用于 Postgresql 数据库，另一个用于 NodeJS 服务器.

• 步骤 3: 配置 Postgresql 数据库服务器

✔ Postgresql Port: … 5432
✔ Postgresql Admin Login: … postgres
✔ Postgresql Admin Password: … postgres

Postgresql 的官方镜像 Postgresql 容器服务器是从 Postgresql 的官方镜像 构建的. 即使大多数需求都已经被提供的 cyk CLI 覆盖，您也可以自由地使用您选择的工具（例如 psql、pgadmin）连接到数据库服务器

• 步骤 4: 配置 NodeJS 服务器

✔ Node Server Port: … 3000
✔ Cyk Admin User: … cyk
✔ Cyk Admin Password: … cyk
✔ Cyk Admin Email: … 

容器服务器是从这个 公共 Docker 镜像 构建的

• 步骤 5: 构建和启动服务器

一旦您配置了 NodeJS 服务器，实用程序将自动执行以下操作:

• 编写配置文件 : package.json, .env, docker-compose.yml
• 在项目文件夹中本地安装cyk命令。

控制台输出将如下所示:

Scaffolding project in /private/tmp/cyk-project...

npm install @cyklang/cli@latest ...

added 108 packages, and audited 109 packages in 18s

38 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities
* npm install @cyklang/cli@latest

Done. Now run:

  cd cyk-project
  npx cyk start  #  will do: docker compose up

• 步骤 6: 启动服务器

进入项目文件夹，然后使用 cyk 命令启动服务器。

cd cyk-project
npx cyk start

输出结果取决于所选择的编排工具，无论是Docker Compose还是Kubernetes。

在Kubernetes的情况下，该命令在计算机与指定端口之间执行"端口转发"，以连接Kubernetes集群的服务。

命令 npx cyk stop 停止cyk服务器。

• 步骤 7: 测试新创建的服务器

请使用您喜爱的浏览器打开NodeJS服务器的主页 :

http://localhost:3000 (将 3000 替换为第 4 步提供的端口号 )

您应该看到: