Skip to content

Commit 7ac615a

Browse files
committed
Updated Documentations for MySQL, PGSQL, MSSQL
1 parent 9d5a76b commit 7ac615a

File tree

1 file changed

+55
-3
lines changed

1 file changed

+55
-3
lines changed

README.md

Lines changed: 55 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ Jangular is a comprehensive starter kit that combines the power of Spring Boot f
1212

1313
- **Full-Stack Solution**: Seamlessly integrates Spring Boot backend with Angular frontend
1414
- **Authentication & Authorization**: Pre-configured security using Spring Security and JWT tokens
15-
- **Database Integration**: MySQL database support with JPA/Hibernate
15+
- **Database Flexibility**: Support for MySQL, PostgreSQL, and MSSQL databases
16+
- **Database Integration**: Database support with JPA/Hibernate
1617
- **Database Migration**: Automated database schema management with Flyway
1718
- **CLI Tool**: Simple command-line interface for project initialization
1819
- **Ready-to-Use Components**: Login, registration, and dashboard components
@@ -29,7 +30,7 @@ Jangular is a comprehensive starter kit that combines the power of Spring Boot f
2930
- Spring Data JPA
3031
- JWT Authentication
3132
- Flyway Migration
32-
- MySQL
33+
- MySQL, PostgreSQL, or MSSQL support
3334
- Lombok
3435
- Maven
3536

@@ -56,7 +57,7 @@ Jangular is a comprehensive starter kit that combines the power of Spring Boot f
5657
- Java 21 or higher
5758
- Node.js 16 or higher
5859
- npm or yarn
59-
- MySQL 8.0 or higher
60+
- MySQL 8.0 or higher, PostgreSQL, or MSSQL
6061
- Maven 3.6 or higher
6162

6263
### Installation
@@ -80,6 +81,19 @@ npm run start:backend
8081
npm run start:frontend
8182
```
8283

84+
#### Interactive CLI Setup
85+
86+
When initializing a new project, the CLI will prompt you for configuration options:
87+
88+
```
89+
Creating new JAngular project: my-project
90+
✔ Enter base package name: com.example.myproject
91+
✔ Select database type: [MySQL/PostgreSQL/MSSQL]
92+
✔ Enter database name: my_project_db
93+
✔ Enter database username: devuser
94+
✔ Enter database password: ********
95+
```
96+
8397
#### CLI Command Reference
8498

8599
```bash
@@ -144,6 +158,43 @@ jangular-project/
144158
└── README.md # Project documentation
145159
```
146160

161+
## Database Configuration
162+
163+
Jangular supports multiple database systems:
164+
165+
### MySQL Configuration
166+
167+
```yaml
168+
spring:
169+
datasource:
170+
url: jdbc:mysql://localhost:3306/your_database_name
171+
username: your_username
172+
password: your_password
173+
driver-class-name: com.mysql.cj.jdbc.Driver
174+
```
175+
176+
### PostgreSQL Configuration
177+
178+
```yaml
179+
spring:
180+
datasource:
181+
url: jdbc:postgresql://localhost:5432/your_database_name
182+
username: your_username
183+
password: your_password
184+
driver-class-name: org.postgresql.Driver
185+
```
186+
187+
### MSSQL Configuration
188+
189+
```yaml
190+
spring:
191+
datasource:
192+
url: jdbc:sqlserver://localhost:1433;databaseName=your_database_name
193+
username: your_username
194+
password: your_password
195+
driver-class-name: com.microsoft.sqlserver.jdbc.SQLServerDriver
196+
```
197+
147198
## Contributing to Templates
148199
149200
Jangular uses Git submodules for the frontend and backend templates:
@@ -293,6 +344,7 @@ changePassword(id: number, oldPassword: string, newPassword: string): Observable
293344
- Customize UI components to match your brand identity
294345
- Add additional Angular modules and components
295346
- Extend authentication with social login providers
347+
- Configure different database providers based on your infrastructure requirements
296348

297349
## Development Workflow
298350

0 commit comments

Comments
 (0)