From 6b112c497e98bfe82aa7299ddc709c97b10d6eb9 Mon Sep 17 00:00:00 2001 From: Keeron Huang Date: Sun, 8 Dec 2024 21:04:28 -0600 Subject: [PATCH] Update README file --- project/server/readme.md | 36 +++++++++++++++++++++++------------- 1 file changed, 23 insertions(+), 13 deletions(-) diff --git a/project/server/readme.md b/project/server/readme.md index 1e2cdb8..5859dda 100644 --- a/project/server/readme.md +++ b/project/server/readme.md @@ -1,26 +1,36 @@ -Backend +# Backend Documentation -# Models -路径: /home/unicareer/project/server/src/models +## Models +**Path**: `/home/unicareer/project/server/src/models` -# Services -路径: /home/unicareer/project/server/src/services +## Services +**Path**: `/home/unicareer/project/server/src/services` -# Tests -路径: /home/unicareer/project/server/src/tests -## 数据库测试 (local) +## Tests +**Path**: `/home/unicareer/project/server/src/tests` + +### Database Testing (Local) + +Run the following command to test the local database: ```bash npm run test:local ``` -## 数据库测试 (db) +### Database Testing (db) + +Run the following command to test the local database: ```bash npm run test:db ``` -option1: -- database.test.ts -> 测试数据库连接 -option2: -- database.test_copy.ts -> 更复杂和全面的测试 +### Options for Database Tests + +Option 1: `database.test.ts` + +Tests basic database connections. + +Option 2: `database.test_copy.ts` + +Includes more complex and comprehensive testing scenarios.