Skip to content

Commit 458fe51

Browse files
authoredOct 26, 2024··
docs: add why unittcms (#88)
1 parent 919556c commit 458fe51

File tree

9 files changed

+85
-24
lines changed

9 files changed

+85
-24
lines changed
 

‎README.md

+25-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,18 @@
1-
# UnitTCMS
1+
<p align="center">
2+
<a href="https://www.unittcms.org/en">
3+
<img width="20%" src="https://raw.githubusercontent.com/kimatata/unittcms/refs/heads/main/frontend/public/favicon/icon-192.png" alt="UnitTCMS" />
4+
<h1 align="center">UnitTCMS</h1>
5+
</a>
6+
</p>
7+
</br>
8+
<p align="center">
9+
<a href="https://github.com/kimatata/unittcms/blob/main/LICENSE">
10+
<img src="https://img.shields.io/github/license/kimatata/unittcms" alt="License">
11+
</a>
12+
<a href="https://github.com/kimatata/unittcms/releases">
13+
<img src="https://img.shields.io/github/v/release/kimatata/unittcms" alt="Release">
14+
</a>
15+
</p>
216

317
UnitTCMS is an open source test case management system. The application is free and designed for self-hosted use. It can be used in environments with strict security requirements. For more information, please visit the demo site and docs.
418

@@ -23,6 +37,16 @@ You can access the app at `http://localhost:8000`
2337

2438
[Looking for a non-Docker way?](https://kimatata.github.io/unittcms/docs/getstarted/manual)
2539

40+
## Why UnitTCMS
41+
42+
There are many test case management tools available in the market, which can be categorized into proprietary and open-source solutions.
43+
44+
Proprietary tools often come with modern, user-friendly interfaces but tend to be cloud-based, which may raise security concerns for some organizations. While some of them do offer on-premises options, these tend to be significantly more expensive.
45+
46+
There are also open-source tools, but many feature older user interfaces that involve frequent page reloads, which can hinder usability.
47+
48+
With these challenges in mind, I set out to develop a modern, user-friendly, open-source test case management tool that anyone can use for free in a secure, self-hosted environment.
49+
2650
## Features
2751

2852
### Project-Based

‎docs/docs/dev/_category_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"label": "Development",
3-
"position": 4
3+
"position": 5
44
}

‎docs/docs/getstarted/_category_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"label": "Get started",
3-
"position": 2
3+
"position": 3
44
}

‎docs/docs/roadmap/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 2
2+
sidebar_position: 6
33
---
44

55
# Roadmap

‎docs/docs/usage/_category_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"label": "Usage",
3-
"position": 3
3+
"position": 4
44
}

‎docs/docs/why.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Why UnitTCMS
6+
7+
No matter the product, it is difficult to manage all testing with automated tests alone. Depending on the environment, Some portion of testing often involves manual test cases. In my team, we have been managing test cases using Excel. While Excel is a highly versatile tool, it is not specifically designed for test case management, which can make it inconvenient in certain scenarios.
8+
9+
For example,
10+
11+
- writing long test procedures can lead to oversized cells
12+
- forced horizontal scrolling
13+
- difficult to attach image files.
14+
- the Excel file may become heavy
15+
- Need to aggregate test cases and visualization
16+
- Not ideal for simultaneous editing by multiple people.
17+
18+
Due to these challenges, it becomes clear that a dedicated tool is necessary when managing a substantial number of manual tests.
19+
20+
## Other tools
21+
22+
There are many test case management tools available in the market, which can be categorized into proprietary and open-source solutions.
23+
24+
Proprietary tools often come with modern, user-friendly interfaces but tend to be cloud-based, which may raise security concerns for some organizations. While some of them do offer on-premises options, these tend to be significantly more expensive.
25+
26+
There are also open-source tools, but many feature older user interfaces that involve frequent page reloads, which can hinder usability.
27+
28+
With these challenges in mind, I set out to develop a modern, user-friendly, open-source test case management tool that anyone can use for free in a secure, self-hosted environment.

‎docs/src/css/custom.css

+15-15
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,25 @@
66

77
/* You can override the default Infima variables here. */
88
:root {
9-
--ifm-color-primary: #205d3b;
10-
--ifm-color-primary-dark: #29784c;
11-
--ifm-color-primary-darker: #277148;
12-
--ifm-color-primary-darkest: #205d3b;
13-
--ifm-color-primary-light: #33925d;
14-
--ifm-color-primary-lighter: #359962;
15-
--ifm-color-primary-lightest: #3cad6e;
9+
--ifm-color-primary: #28d06c;
10+
--ifm-color-primary-dark: #24b860;
11+
--ifm-color-primary-darker: #20a256;
12+
--ifm-color-primary-darkest: #1b8a48;
13+
--ifm-color-primary-light: #3add80;
14+
--ifm-color-primary-lighter: #5be593;
15+
--ifm-color-primary-lightest: #7bedaa;
1616
--ifm-code-font-size: 95%;
1717
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
1818
}
1919

2020
/* For readability concerns, you should choose a lighter palette in dark mode. */
2121
[data-theme='dark'] {
22-
--ifm-color-primary: #4fddbf;
23-
--ifm-color-primary-dark: #21af90;
24-
--ifm-color-primary-darker: #1fa588;
25-
--ifm-color-primary-darkest: #1a8870;
26-
--ifm-color-primary-light: #29d5b0;
27-
--ifm-color-primary-lighter: #32d8b4;
28-
--ifm-color-primary-lightest: #4fddbf;
29-
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
22+
--ifm-color-primary: #28d06c;
23+
--ifm-color-primary-dark: #24b860;
24+
--ifm-color-primary-darker: #20a256;
25+
--ifm-color-primary-darkest: #1b8a48;
26+
--ifm-color-primary-light: #3add80;
27+
--ifm-color-primary-lighter: #5be593;
28+
--ifm-color-primary-lightest: #7bedaa;
29+
--docusaurus-highlighted-code-line-bg: rgba(255, 255, 255, 0.15);
3030
}

‎docs/src/pages/index.js

+7-4
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,18 @@ export default function Home() {
99
const { siteConfig } = useDocusaurusContext();
1010
return (
1111
<Layout title={`Hello from ${siteConfig.title}`} description="Description will go into a meta tag in <head />">
12-
<header className={clsx('hero hero--primary', styles.heroBanner)}>
12+
<header className={clsx('hero', styles.heroBanner)}>
1313
<div className="container">
1414
<Heading as="h1" className="hero__title">
1515
UnitTCMS Docs
1616
</Heading>
1717
<p className="hero__subtitle">Open Source Test Case Management System</p>
18-
<div>
19-
<Link className="button button--secondary button--lg" to="/docs">
20-
Move to Docs📰
18+
<div className={styles.buttons}>
19+
<Link className="button button--primary button--lg" to="/docs">
20+
Docs📰
21+
</Link>
22+
<Link className="button button--secondary button--lg" to="https://github.com/kimatata/unittcms">
23+
GitHub
2124
</Link>
2225
</div>
2326
</div>

‎docs/src/pages/index.module.css

+6
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,15 @@
55

66
.heroBanner {
77
padding: 4rem 0;
8+
text-align: center;
89
position: relative;
910
overflow: hidden;
1011
}
1112

13+
.heroTitle {
14+
color: blueviolet;
15+
}
16+
1217
@media screen and (max-width: 996px) {
1318
.heroBanner {
1419
padding: 2rem;
@@ -18,6 +23,7 @@
1823

1924
.buttons {
2025
display: flex;
26+
column-gap: 10px;
2127
align-items: center;
2228
justify-content: center;
2329
}

0 commit comments

Comments
 (0)
Please sign in to comment.