typescript - 具有同等重要的服务器端和客户端部分的项目的典型目录结构

Question

我们将发布一个开源库，其中包含一个用 C# 编写的服务器端部分(用于 Web API、提取元数据、数据库相关操作等)和一个用 TypeScript 编写的执行 UI 的客户端部分.
通常，我们的存储库具有经典结构，例如:

docs/- 文档

样本/- 一些样本项目

src/- 库本身的源代码

测试/- 单元和集成测试

但是，现在我不确定如何组织这个 Git 存储库，因为所有这些部分(除了，可能包含这两个部分的示例项目)对于客户端和服务器端将完全不同。
所以，现在，我们得到了这样的结构:

sample /

客户/

文档/

src/

测试/

服务器/

文档/

src/

测试/

但是，我仍然不太确定这种结构，希望听到社区的任何想法或建议。
可能，最好将它放在 2 个不同的存储库中？但是，我们希望保留客户端和服务器端部分的统一版本控制，并且不想不必要地使事情复杂化。

Answer 1

您可以使用 git-submodules以便 server和 client存在单独的报告并在一个将它们整理在一起的存储库中，但您为服务器和客户端引用单独的存储库。来自 git-submodules文档:

A common issue arises in these scenarios: you want to be able to treat the two projects as separate yet still be able to use one from within the other.

您可以采用如下命名约定:

项目/客户

项目/服务器

项目/项目

您提议的目录结构将得到维护，但代码将被拆分到多个存储库中。