Merge branch 'master' into chat_belongings

lemredd · Sep 11, 2022 · 5c94c7d · 5c94c7d
2 parents e46a8d4 + 87244d5
commit 5c94c7d
Show file tree

Hide file tree

Showing 173 changed files with 1,223 additions and 659 deletions.
diff --git a/.github/workflows/back-end.intg.yml b/.github/workflows/back-end.intg.yml
@@ -74,4 +74,4 @@ jobs:
     - run: npm run build
     - run: ./execute.ps1 -test intg:back
       shell: pwsh
-      timeout-minutes: 5
+      timeout-minutes: 6
diff --git a/CONVENTIONAL_COMMITS.md b/CONVENTIONAL_COMMITS.md
@@ -0,0 +1,62 @@
+## Conventional Commits
+The purpose of this documentation is to guide collaborators of this project on committing according
+to the type of change.
+
+### Primary types
+These are the general types of commit that repository has. There MAY be other types that will be
+proposed in the future.
+
+Type        | Description
+--- | ---
+*feat:*     | A type that focuses on the project's enhancement by implementing a new feature that is **felt or seen** by the users via browsers or APIs.
+*types:*    | A type that focuses on commits to type files and application of new types to other components
+*style:*    | This focuses on any kinds of changes in UI.
+*config:*   | This focuses on changes in the configuration files of the project.
+*ci:*       | A *config:* type where it focuses on changes in configurations of workflows.
+*fix:*      | This focuses on debugging and solving problems in features, tests, or configurations.
+*refactor:* | This focuses on refactored code.
+*perf:*     | A *refactor:* type where it focuses on optimizing code.
+*rfmt:*     | A *refactor:* type where it focuses on reformed HTML templates.
+*docs:*     | This focuses on additions or changes in any of the documentation files.
+*intrn:*    | Any commit that do not contribute to features but it is within on the **internals** of the feature.
+*share:*    | A specific *intrn:* type focuses on general additions/changes/removal in shareable code.
+*dx:*       | A type for commits which improved the developer experience but does not add value to the clients.
+*test:*     | This focuses on any kinds of test scripts.
+*unit:*     | A *test:* type for commits that focuses to unit tests.
+*intg:*     | A *test:* type for commits that focuses to integration tests.
+*chore:*    | Any other commits that are still uncategorized falls into this commit.
+
+For more information, please visit the [specification].
+
+### Scoped types
+If a commit type has multiple types, it is possible to nest it under a primary type. For instance, a
+"Test" commit can be classified as either unit or integration. To further specify the type of
+commit, one can use "test(unit):" or "test(integration):". Below are scoped types usually used
+during development.
+
+Scope          | Description | Remarks
+--- | --- | ---
+server         |  For commits which affect server's mechanism (middlewares, routing, etc...).      | -
+database       |  For commits which affect the communication between the app server and database.  | -
+authentication |  For commits which affect authentication components.                              | -
+email          |  For commits which affect email components or communication to SMTP server.       | -
+call           |  For commits which affect call components or peer communication                   | -
+deps           |  For commits which add, remove, or change dependencies                            | Strictly for *chore:* types only and are excluded in logs.
+unit           |  For commits which affect the unit tests                                          | Strictly for *test:* types only
+integration    |  For commits which affect the integration tests                                   | Strictly for *test:* types only
+
+Note that some of the scopes are only recommendations. It is up to the developer's discretion on
+what name would the scoped commit be given, as long as it lines up to the focus of the commit and is
+appropriate.
+
+### Guidelines
+- When specifying scopes, complete spelling of the type is a MUST.
+- Lowercase SHOULD be used for the scopes. The tool will properly capitalize the first letter upon
+  generating the change log.
+- Uppercase SHOULD be used if the scope is an acronym.
+- It is best to follow the current scopes before the next release. Upon releasing the new version,
+  developers SHOULD apply the new spellings of the labels.
+- New scopes MAY be committed immediately.
+
+### Further Reading
+There is also a good [article] to read about the Conventional Commits.
diff --git a/README.md b/README.md
@@ -12,7 +12,10 @@ as shown here.
 ### Prerequisites
 - [Node.js and NPM]. LTS version is recommended
 - [Docker]
+- [DB Browser for SQLite] if `filed_sqlite` is preferred.
 - [PostgreSQL]. [v14.3] is recommended.
+- [Python]. [v3 or higher]
+- [Visual Studio Build Tools]. [v2017 or higher] with desktop development with C++
 
 ### General Development Instruction
 1. Run `npm install`
@@ -62,67 +65,7 @@ as shown here.
 8. Visit http://localhost:16000
 
 ## Conventional Commits
-The purpose of this documentation is to guide collaborators of this project on committing according
-to the type of change.
-
-### Primary types
-These are the general types of commit that repository has. There MAY be other types that will be
-proposed in the future.
-
-Type        | Description
---- | ---
-*feat:*     | A type that focuses on the project's enhancement by implementing a new feature that is **felt or seen** by the users via browsers or APIs.
-*types:*    | A type that focuses on commits to type files and application of new types to other components
-*style:*    | This focuses on any kinds of changes in UI.
-*config:*   | This focuses on changes in the configuration files of the project.
-*ci:*       | A *config:* type where it focuses on changes in configurations of workflows.
-*fix:*      | This focuses on debugging and solving problems in features, tests, or configurations.
-*refactor:* | This focuses on refactored code.
-*perf:*     | A *refactor:* type where it focuses on optimizing code.
-*rfmt:*     | A *refactor:* type where it focuses on reformed HTML templates.
-*docs:*     | This focuses on additions or changes in any of the documentation files.
-*intrn:*    | Any commit that do not contribute to features but it is within on the **internals** of the feature.
-*share:*    | A specific *intrn:* type focuses on general additions/changes/removal in shareable code.
-*dx:*       | A type for commits which improved the developer experience but does not add value to the clients.
-*test:*     | This focuses on any kinds of test scripts.
-*unit:*     | A *test:* type for commits that focuses to unit tests.
-*intg:*     | A *test:* type for commits that focuses to integration tests.
-*chore:*    | Any other commits that are still uncategorized falls into this commit.
-
-For more information, please visit the [specification].
-
-### Scoped types
-If a commit type has multiple types, it is possible to nest it under a primary type. For instance, a
-"Test" commit can be classified as either unit or integration. To further specify the type of
-commit, one can use "test(unit):" or "test(integration):". Below are scoped types usually used
-during development.
-
-Scope          | Description | Remarks
---- | --- | ---
-server         |  For commits which affect server's mechanism (middlewares, routing, etc...).      | -
-database       |  For commits which affect the communication between the app server and database.  | -
-authentication |  For commits which affect authentication components.                              | -
-email          |  For commits which affect email components or communication to SMTP server.       | -
-call           |  For commits which affect call components or peer communication                   | -
-deps           |  For commits which add, remove, or change dependencies                            | Strictly for *chore:* types only and are excluded in logs.
-unit           |  For commits which affect the unit tests                                          | Strictly for *test:* types only
-integration    |  For commits which affect the integration tests                                   | Strictly for *test:* types only
-
-Note that some of the scopes are only recommendations. It is up to the developer's discretion on
-what name would the scoped commit be given, as long as it lines up to the focus of the commit and is
-appropriate.
-
-### Guidelines
-- When specifying scopes, complete spelling of the type is a MUST.
-- Lowercase SHOULD be used for the scopes. The tool will properly capitalize the first letter upon
-  generating the change log.
-- Uppercase SHOULD be used if the scope is an acronym.
-- It is best to follow the current scopes before the next release. Upon releasing the new version,
-  developers SHOULD apply the new spellings of the labels.
-- New scopes MAY be committed immediately.
-
-### Further Reading
-There is also a good [article] to read about the Conventional Commits.
+Visit [this detailed instructions](./CONVENTIONAL_COMMITS.md) for more details
 
 ## Development
 There is a custom script in this repository to aid the development. Here are some of the custom commands:
@@ -161,6 +104,7 @@ what to add at the end of the messages.
 [RFC8174]: https://datatracker.ietf.org/doc/html/rfc8174
 [Node.js and NPM]: https://nodejs.org/en/
 [Docker]: https://www.docker.com/get-started/
+[DB Browser for SQLite]: https://www.w.co
 [PostgreSQL]: https://www.postgresql.org/download/windows/
 [v14.3]: https://www.enterprisedb.com/downloads/postgres-postgresql-downloads
 [installer]: https://www.enterprisedb.com/downloads/postgres-postgresql-downloads