LivrEtec

Livetec

早上好，下午好或晚安。该项目是Etec Aristotle Ferreira学校图书馆藏品的经理

项目

在此存储库中，将有三个项目：

• 图书馆员工使用的GIB （图书馆内部经理）来管理书籍和贷款。
• 学生使用的APB （图书馆的公共集合）来查看库中包含的书籍的集合。
• 教师的公共API建议学生使用，测试HTTP呼叫以及学生制作的流行网站。

工具

• Docker ：隔离测试环境
• .NET核心：整个后端的平台
• mySQL ：数据库
• 实体框架：ORM将应用程序连接到数据库
• GRPC ：作为GIB服务器与客户之间的通信协议
• 大黄金混合动力车 +毛伊岛：GIB客户界面
• Xunit ：执行图书馆单元测试
• DOCFX ：用于创建文档
• 无花果：进行原型设计

如何执行

目前正在部分完成GRPC中制造的GIB内部API。可以执行项目的单元测试。

运行GIB API

您可以通过两种方式运行API：使用机器环境或使用Docker。如果已经安装或无法在机器环境中安装执行要求，最好使用Docker。

由于带宽，可能需要时间安装图像和软件包。

在本地环境中运行

要在本地环境中执行以下要求：

• .NET 6.0.0
• mysql

有必要在执行之前配置文件./src/LivrEtec.GIB.Servidor/appsettings.json

我建议复制appsettings.modelo.json文件，并根据您的MySQL Server用作身份验证密钥和连接字符串的字符串填充AuthKey属性。用作Docker中使用的AppSetting文件的示例。

配置项目后，您在Visual Studio中打开项目，然后选择LivreTec.gib.servator作为启动项目，或在终端模拟器上运行./src/LivrEtec.GIB.Servidor

dotnet run

如果未正确配置AppSetting，例如连接字符串或无效端口，则可能会发生错误。如果有任何错误，请舒适地发布

使用Docker运行

要使用Docker运行服务器很简单，只需在./src文件夹中运行以下命令

docker compose --profile backend up --build

如前所述，由于有必要下载图像和软件包Nuget可能需要几分钟才能根据您的互联网频段下载。

打电话

执行项目后，他将通知他正在听的门。由于尚未配置SSL证书，因此建议使用HTTP标准。

要拨打API，请选择您选择的GRPC客户。

一些替代方案是失眠或邮递员。

原始API文件位于./src/livretec.gib/protos/acervo.proto。

之后，有必要通过login GerenciamentoSessao中的请求登录到API。需要登录名来命名登录和密码哈希，但是第一次启动服务器时，它将使用admin:senha和id 1的用户创建用户。

密码哈希需要如下生成： md5(senha + id) 。

因此请求应如下：

{
	"IdUsuario" : 1 ,
	"HashSenha" : " 92f20dafc5e5ac1c66820903c492cc04 "
}

然后它将返回JWT令牌，该标记应如下： Authorization: Bearer <JWT Token>

好的，现在您可以作为管理员访问其余API。

执行测试

就像可以在本地环境和Docker中测试GIB API一样，您也可以在没有安装的MySQL Server的情况下进行一些测试。

当地环境

测试分为两个：

• 使用sqllite测试测试过程中每个服务的本地测试
• 远程测试是集成测试。

要仅执行本地测试，只需安装.NET 6.0.0和在文件夹中./src/执行以下命令：

dotnet test LivrEtec.sln --filter Category=local

如果您使用的是Visual Studio打开测试管理器并运行local测试类别

要执行远程测试，您必须首先运行GIB服务器。执行后，您需要创建和配置./src/LivrEtec.Testes/appsettings.json文件。

复制AppSettings.modelo.json文件，并用填充Gib Server AppSettings的相同信息以及添加服务器链接，如果链接以这种格式出现： http://[::]:21312表示与http://localhost:21312

在配置服务器和测试以执行项目之后，只需在./src/目录中运行以下命令

dotnet test LivrEtec.sln

在Visual Studio中，只需打开测试管理器，然后单击“运行”。

Docker

如果要使用docker，只需转到文件夹./src/ ，然后使用以下命令运行容器：

docker compose --profile teste up --build

--build是为了确保使用最新代码执行容器。

运行测试后，数据库容器将继续运行。如果您想在测试之后自动出现，请在命令中添加--exit-code-from app作为标志。

设计

该设计可从https://figma.com/community/file/1176031299741420547获得

如何合作

如果您想协作，欢迎所有帮助。我们建议您首先转到（Wiki）[./ Wiki/ wiki/ Projects-of-projects]，并阅读一些以获取项目概述，然后寻找（./ esloge）您感兴趣的任何问题。如果您找到一个项目叉，进行修改，然后进行项目的拉动，然后对项目进行拉动。请确保在进行Pull请求之前进行测试，并对其进行测试，并对其进行了测试，并将您的整个验证为您，并进行了所有的测试，并进行了整个测试，并进行了所有测试。

文档

有关该项目的更多信息，请参阅我们的文档。

欢迎 ：）