docs: sprint2 doc

sustech-cs304 · Jun 4, 2024 · a264dd1 · a264dd1
1 parent d421e48
commit a264dd1
Show file tree

Hide file tree

Showing 12 changed files with 36 additions and 0 deletions.
diff --git a/reports/Team Project - Proposal.md → reports/proposal/Team Project - Proposal.md b/reports/Team Project - Proposal.md → reports/proposal/Team Project - Proposal.md
diff --git a/reports/img/1.png → reports/proposal/img/1.png b/reports/img/1.png → reports/proposal/img/1.png
diff --git a/reports/img/2_1.png → reports/proposal/img/2_1.png b/reports/img/2_1.png → reports/proposal/img/2_1.png
diff --git a/reports/img/2_2.png → reports/proposal/img/2_2.png b/reports/img/2_2.png → reports/proposal/img/2_2.png
diff --git a/reports/img/2_3.png → reports/proposal/img/2_3.png b/reports/img/2_3.png → reports/proposal/img/2_3.png
diff --git a/reports/img/2_4.png → reports/proposal/img/2_4.png b/reports/img/2_4.png → reports/proposal/img/2_4.png
diff --git a/reports/img/2_5.png → reports/proposal/img/2_5.png b/reports/img/2_5.png → reports/proposal/img/2_5.png
diff --git a/reports/img/3.png → reports/proposal/img/3.png b/reports/img/3.png → reports/proposal/img/3.png
diff --git a/reports/img/4.png → reports/proposal/img/4.png b/reports/img/4.png → reports/proposal/img/4.png
diff --git a/reports/img/p2_1.png → reports/proposal/img/p2_1.png b/reports/img/p2_1.png → reports/proposal/img/p2_1.png
diff --git a/reports/img/p2_2.png → reports/proposal/img/p2_2.png b/reports/img/p2_2.png → reports/proposal/img/p2_2.png
diff --git a/reports/sprint2/final-report-team0.md b/reports/sprint2/final-report-team0.md
@@ -0,0 +1,36 @@
+# Moras - Sprint2
+
+## 1. Metrics
+script: [statics.sh](../../scripts/stastics.sh)
+| Lines of Code | Number of packages/modules | Number of Modules | Number of source files | Number of dependencies |
+| ------------- | -------------------------- | ----------------- | ---------------------- | ---------------------- |
+|               |                            |                   |                        |                        |
+
+## 2. Documentation
+Documentation for end users: [https://rosswasd.github.io/team-project-24spring-0/](https://rosswasd.github.io/team-project-24spring-0/)
+Documentation for developers: [https://sustech-cs304.github.io/team-project-24spring-0/moras/](https://sustech-cs304.github.io/team-project-24spring-0/moras/)
+
+## 3. Tests
+- tools: `cargo tarpaulin`
+- tasks: `cargo tarpaulin --out html`
+- source code: [tests folder](../../src-tauri/src/tests), [ci test task](../../.github/workflows/build.yml), [coverage report script](../../scripts/report.sh)
+- coverage report: [coverage report](https://sustech-cs304.github.io/team-project-24spring-0/report#src)
+
+## 4. Build
+- tools: `cargo`, `npm`, `github CI/CD`
+- frameworks: `tauri`
+- tasks:
+  - CI ([build.yaml](../../.github/workflows/build.yml))
+    - format check: `cargo fmt -- --check`, `npm run format-check`
+    - generate test coverage report: [report.sh](../../scripts/report.sh) (`cargo tarpaulin --out Html`)
+    - run tests: `cargo test` 
+    - generate documentation and test reports: `cargo doc --no-deps`
+    - deploy documentation and report to GitHub Pages
+  - CD ([release.yaml](../../.github/workflows/release.yml))
+    - build for multiple platforms: `TODO`
+    - deploy executable to GitHub
+- executable: [https://github.com/sustech-cs304/team-project-24spring-0/releases](https://github.com/sustech-cs304/team-project-24spring-0/releases)
+- buildfile: [Cargo.toml](../../src-tauri/Cargo.toml), [package.json](../../src-ui/package.json), [build.yaml](../../.github/workflows/build.yml), [release.yaml](../../.github/workflows/release.yml)
+
+## 5. Deployment
+This is a desktop application without any online services, so there is no need for deployment. However, we use GitHub CD to automatically build our application for multiple platforms. [release.yaml](../../.github/workflows/release.yml)