Skip to content

Commit 98856ec

Browse files
AnanthaRajuCAnanthaRajuC
committed
DOCS: Updated
1 parent 599a907 commit 98856ec

File tree

6 files changed

+92
-88
lines changed

6 files changed

+92
-88
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Essentially it's a simple on-demand application backend for rapd-prototyping.
1515
Features include but not limited to:
1616

1717
- [Authentication](documents/AUTHENTICATION.MD)
18-
- [User Roles](documents/USER_ROLES.MD)
18+
- [User Roles](documents/USER_ROLES.MD)
1919
- [Internationalization (i18n)](documents/INTERNATIONALIZATION.MD)
2020

2121
<div align="center">

‎documents/TECHNOLOGY_STACK.MD‎

Lines changed: 36 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
<details open="open">
44
<ul>
5+
<li><a href="#overview">Overview</a></li>
56
<li><a href="#data">Data</a></li>
67
<li><a href="#client---frontend-ui">Client - Frontend/UI</a></li>
78
<li><a href="#server---backend">Server - Backend</a></li>
@@ -11,6 +12,15 @@
1112
</ul>
1213
</details>
1314

15+
### Overview
16+
17+
|Technology |Description |
18+
|--------------------------|--------------------|
19+
|Core Framework |Spring Boot2 |
20+
|Security Framework |Spring Security, JWT|
21+
|Persistent Layer Framework|Spring Data JPA |
22+
|Database |MySQL |
23+
1424
### Data
1525

1626
| Technology | Description |
@@ -38,41 +48,35 @@
3848

3949
### Libraries and Plugins
4050

41-
<details open="open">
42-
<ul>
43-
<li><a href="https://afeld.github.io/bootstrap-toc/">Bootstrap ToC</a> - Table of Contents plugin for Bootstrap</li>
44-
<li><a href="https://github.com/cdimascio/dotenv-java">dotenv-java</a> - A no-dependency, pure Java port of the Ruby dotenv project. Load environment variables from a .env file.</li>
45-
<li><a href="https://github.com/Antibrumm/thymeleaf-extras-with-dialect">Thymeleaf With Dialect</a> - A dialect for Thymeleaf that allows you to use attributes with a &quot;with&quot; prefix to avoid having long &quot;th:with&quot;-expressions.</li>
46-
<li><a href="https://github.com/ultraq/thymeleaf-layout-dialect">Thymeleaf Layout Dialect</a> - A dialect for Thymeleaf that lets you build layouts and reusable templates in order to improve code reuse.</li>
47-
<li><a href="https://projectlombok.org/">Lombok</a> - Never write another getter or equals method again, with one annotation your class has a fully featured builder, Automate your logging variables, and much more.</li>
48-
<li><a href="https://swagger.io/">Swagger</a> - Open-Source software framework backed by a large ecosystem of tools that helps developers design, build, document, and consume RESTful Web services.</li>
49-
<li><a href="https://github.com/vladimir-bukhtoyarov/bucket4j">Bucket4j</a> - Java rate limiting library based on token/leaky-bucket algorithm.</li>
50-
</ul>
51-
</details>
51+
| Technology | Description |
52+
|-----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
53+
|<a href="https://afeld.github.io/bootstrap-toc/">Bootstrap ToC</a> |Table of Contents plugin for Bootstrap |
54+
|<a href="https://github.com/cdimascio/dotenv-java">dotenv-java</a> |A no-dependency, pure Java port of the Ruby dotenv project. Load environment variables from a .env file. |
55+
|<a href="https://github.com/Antibrumm/thymeleaf-extras-with-dialect">Thymeleaf With Dialect</a>|A dialect for Thymeleaf that allows you to use attributes with a &quot;with&quot; prefix to avoid having long &quot;th:with&quot;-expressions. |
56+
|<a href="https://github.com/ultraq/thymeleaf-layout-dialect">Thymeleaf Layout Dialect</a> |A dialect for Thymeleaf that lets you build layouts and reusable templates in order to improve code reuse. |
57+
|<a href="https://projectlombok.org/">Lombok</a> |Never write another getter or equals method again, with one annotation your class has a fully featured builder, Automate your logging variables, and much more.|
58+
|<a href="https://swagger.io/">Swagger</a> |Open-Source software framework backed by a large ecosystem of tools that helps developers design, build, document, and consume RESTful Web services. |
59+
|<a href="https://github.com/vladimir-bukhtoyarov/bucket4j">Bucket4j</a> |Java rate limiting library based on token/leaky-bucket algorithm. |
5260

5361
### Others
5462

55-
<details open="open">
56-
<ul>
57-
<li><a href="https://git-scm.com/">git</a> - Free and Open-Source distributed version control system</li>
58-
<li><a href="https://prometheus.io/">Prometheus</a> - Monitoring system and time series database</li>
59-
<li><a href="https://github.com/spotify/dockerfile-maven">Dockerfile Maven</a> - This Maven plugin integrates Maven with Docker</li>
60-
<li><a href="https://www.docker.com/">Docker</a> - A set of platform as a service products that use OS-level virtualization to deliver software in packages called containers.</li>
61-
</ul>
62-
</details>
63+
| Technology | Description |
64+
|--------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
65+
|<a href="https://git-scm.com/">git</a> |Free and Open-Source distributed version control system |
66+
|<a href="https://prometheus.io/">Prometheus</a> |Monitoring system and time series database |
67+
|<a href="https://github.com/spotify/dockerfile-maven">Dockerfile Maven</a>|This Maven plugin integrates Maven with Docker |
68+
|<a href="https://www.docker.com/">Docker</a> |A set of platform as a service products that use OS-level virtualization to deliver software in packages called containers.|
6369

6470
### External Tools & Services
6571

66-
<details open="open">
67-
<ul>
68-
<li><a href="https://mailtrap.io/">Mailtrap</a> - Safe Email Testing for Staging &amp; Development.</li>
69-
<li><a href="https://www.getpostman.com/">Postman</a> - API Development Environment (Testing Docmentation)</li>
70-
<li><a href="https://docs.postman-echo.com/?version=latest">Postman Echo</a> - A service that can be used to test your REST clients and make sample API calls. It provides endpoints for GET, POST, PUT, various auth mechanisms and other utility endpoints.</li>
71-
<li><a href="https://travis-ci.org/github/Spring-Boot-Framework/Spring-Boot-Application-Template">Travis CI</a> - A hosted continuous integration service used to build and test software projects hosted at GitHub and Bitbucket.</li>
72-
<li><a href="https://codecov.io/gh/Spring-Boot-Framework/Spring-Boot-Application-Template">Codecov</a> - A hosted tool that is used to measure the test coverage of your codebase.</li>
73-
<li><a href="https://dependabot.com/">Dependabot</a> - Automated dependency updates.</li>
74-
<li><a href="https://fossa.com/">FOSSA</a> - Scalable, end-to-end management for third-party code, license compliance and vulnerabilities.</li>
75-
<li><a href="https://sonarcloud.io/dashboard?id=Spring-Boot-Framework_Spring-Boot-Application-Template">sonarcloud</a> - Cloud-based code analysis service designed to detect code quality issues continuously ensuring the maintainability, reliability and security of code.</li>
76-
<li><a href="https://www.toptal.com/developers/gitignore/api/java,eclipse,intellij">gitignore.io</a> - Create useful .gitignore files for your project.</li>
77-
</ul>
78-
</details>
72+
| Technology | Description |
73+
|------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
74+
|<a href="https://mailtrap.io/">Mailtrap</a> |Safe Email Testing for Staging &amp; Development. |
75+
|<a href="https://www.getpostman.com/">Postman</a> |API Development Environment (Testing Docmentation) |
76+
|<a href="https://docs.postman-echo.com/?version=latest">Postman Echo</a> |A service that can be used to test your REST clients and make sample API calls. It provides endpoints for GET, POST, PUT, various auth mechanisms and other utility endpoints.|
77+
|<a href="https://travis-ci.org/github/Spring-Boot-Framework/Spring-Boot-Application-Template">Travis CI</a> |A hosted continuous integration service used to build and test software projects hosted at GitHub and Bitbucket. |
78+
|<a href="https://codecov.io/gh/Spring-Boot-Framework/Spring-Boot-Application-Template">Codecov</a> |A hosted tool that is used to measure the test coverage of your codebase. |
79+
|<a href="https://dependabot.com/">Dependabot</a> |Automated dependency updates. |
80+
|<a href="https://fossa.com/">FOSSA</a> |Scalable, end-to-end management for third-party code, license compliance and vulnerabilities. |
81+
|<a href="https://sonarcloud.io/dashboard?id=Spring-Boot-Framework_Spring-Boot-Application-Template">sonarcloud</a>|Cloud-based code analysis service designed to detect code quality issues continuously ensuring the maintainability, reliability and security of code. |
82+
|<a href="https://www.toptal.com/developers/gitignore/api/java,eclipse,intellij">gitignore.io</a> |Create useful .gitignore files for your project. |

‎src/main/java/io/github/anantharajuc/sbat/core_backend/persistence/model/ApplicationSetings.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,12 @@ public class ApplicationSetings extends AuditEntity
3939
{
4040
private static final long serialVersionUID = 1L;
4141

42-
@ApiModelProperty(notes="Application Event", value="${ApplicationSetings.appKey}", example="API_KEY")
42+
@ApiModelProperty(notes="Application Key", value="${ApplicationSetings.appKey}", example="API_KEY")
4343
@Size(min=3, max=25, message="App Key must be between 3 and 25 characters.")
4444
@Column(name="app_key", nullable = false)
4545
String appKey;
4646

47-
@ApiModelProperty(notes="Application Event", value="${ApplicationSetings.appValue}", example="1eGHY@T-dre565-56yrtr")
47+
@ApiModelProperty(notes="Application Value", value="${ApplicationSetings.appValue}", example="1eGHY@T-dre565-56yrtr")
4848
@Size(min=3, max=100, message="App Value must be between 3 and 100 characters.")
4949
@Column(name="app_value", nullable = false)
5050
String appValue;

‎src/main/resources/application.properties‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
# https://docs.spring.io/spring-boot/docs/current/reference/html/appendix-application-properties.html
33

44
# Comma-separated list of active profiles. Can be overridden by a command line switch.
5-
spring.profiles.active=test
5+
spring.profiles.active=dev

‎src/main/resources/data/mysql/migrations/V0_0_1__SBAT_structure_basic.sql‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -23,45 +23,45 @@ grant all privileges on *.* to 'USERNAME'@'IPADDRESS' with grant option;
2323
--
2424

2525
CREATE TABLE `sbat_log` (
26-
`id` bigint(20) NOT NULL AUTO_INCREMENT,
27-
`created_by` varchar(255) NOT NULL,
28-
`created_date` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
29-
`last_modified_by` varchar(255) NOT NULL,
30-
`last_modified_date` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
31-
`details` varchar(255) NOT NULL,
32-
`event` varchar(255) NOT NULL,
26+
`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'Unique ID for each entry.',
27+
`created_by` varchar(255) NOT NULL COMMENT 'Field representing the principal that created the entity containing the field.',
28+
`created_date` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT 'Field representing the date the entity containing the field was created.',
29+
`last_modified_by` varchar(255) NOT NULL COMMENT 'Field representing the principal that recently modified the entity containing the field.',
30+
`last_modified_date` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT 'Field representing the date the entity containing the field was recently modified.',
31+
`details` varchar(255) NOT NULL COMMENT 'Application Event Details.',
32+
`event` varchar(255) NOT NULL COMMENT 'Application Event.',
3333
PRIMARY KEY (`id`)
34-
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4;
34+
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COMMENT='Application Log.';
3535

3636
--
3737
-- Table structure for table `built_with`
3838
--
3939

4040
CREATE TABLE `sbat_built_with` (
41-
`id` bigint(20) NOT NULL AUTO_INCREMENT,
42-
`created_by` varchar(255) NOT NULL,
43-
`created_date` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
44-
`last_modified_by` varchar(255) NOT NULL,
45-
`last_modified_date` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
41+
`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'Unique ID for each entry.',
42+
`created_by` varchar(255) NOT NULL COMMENT 'Field representing the principal that created the entity containing the field.',
43+
`created_date` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT 'Field representing the date the entity containing the field was created.',
44+
`last_modified_by` varchar(255) NOT NULL COMMENT 'Field representing the principal that recently modified the entity containing the field.',
45+
`last_modified_date` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT 'Field representing the date the entity containing the field was recently modified.',
4646
`description` varchar(255) DEFAULT NULL,
4747
`link` varchar(255) DEFAULT NULL,
4848
`name` varchar(255) NOT NULL,
4949
`version` varchar(255) DEFAULT NULL,
5050
PRIMARY KEY (`id`)
51-
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4;
51+
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COMMENT='List of tools used to build the app.';
5252

5353
--
5454
-- Table structure for table `sbat_settings`
5555
--
5656

5757
CREATE TABLE `sbat_settings` (
58-
`id` bigint(20) NOT NULL AUTO_INCREMENT,
59-
`created_by` varchar(255) NOT NULL,
60-
`created_date` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
61-
`last_modified_by` varchar(255) NOT NULL,
62-
`last_modified_date` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
58+
`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'Unique ID for each entry.',
59+
`created_by` varchar(255) NOT NULL COMMENT 'Field representing the principal that created the entity containing the field.',
60+
`created_date` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT 'Field representing the date the entity containing the field was created.',
61+
`last_modified_by` varchar(255) NOT NULL COMMENT 'Field representing the principal that recently modified the entity containing the field.',
62+
`last_modified_date` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT 'Field representing the date the entity containing the field was recently modified.',
6363
`app_key` varchar(255) NOT NULL,
6464
`app_value` varchar(255) NOT NULL,
6565
`description` varchar(255) NOT NULL,
6666
PRIMARY KEY (`id`)
67-
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4;
67+
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COMMENT='Application Settings.';

0 commit comments

Comments
 (0)