README.md File

🚪 Stack : Spring boot
🌠 Version: 3.0.4
📕 Gruop ID : com.readme
📘 Artifact ID : rss
📙 Java Version :17
📚 DB : MariaDB

Project Period
2023-03-042023-05-12

Project Architecture (Tree Structure)

.   
├── java   
│   └── com   
│       └── readme   
│           └── rss   
│               ├── controller   
│               │   ├── MarkdownController.java   
│               │   └── UnzipController.java   
│               ├── data   
│               │   ├── dao   
│               │   │   ├── FrameworkDAO.java   
│               │   │   ├── Impl   
│               │   │   │   ├── FrameworkDAOImpl.java   
│               │   │   │   ├── ProjectDAOImpl.java   
│               │   │   │   └── UserDAOImpl.java   
│               │   │   ├── ProjectDAO.java   
│               │   │   └── UserDAO.java   
│               │   ├── dto   
│               │   │   ├── FrameworkDTO.java   
│               │   │   ├── ProjectDTO.java   
│               │   │   └── UserDTO.java   
│               │   ├── entity   
│               │   │   ├── compositeKey   
│               │   │   │   └── ProjectPK.java   
│               │   │   ├── FrameworkEntity.java   
│               │   │   ├── ProjectEntity.java   
│               │   │   └── UserEntity.java   
│               │   ├── handler   
│               │   │   ├── FrameworkHandler.java   
│               │   │   ├── Impl   
│               │   │   │   ├── FrameworkHandlerImpl.java   
│               │   │   │   ├── ProjectHandlerImpl.java   
│               │   │   │   └── UserHandlerImpl.java   
│               │   │   ├── ProjectHandler.java   
│               │   │   └── UserHandler.java   
│               │   ├── repository   
│               │   │   ├── FrameworkRepository.java   
│               │   │   ├── ProjectRepository.java   
│               │   │   └── UserRepository.java   
│               │   └── service   
│               │       ├── FrameworkService.java   
│               │       ├── Impl   
│               │       │   ├── FrameworkServiceImpl.java   
│               │       │   ├── MdDownloadServiceImpl.java   
│               │       │   ├── ProjectServiceImpl.java   
│               │       │   ├── RegisterServiceImpl.java   
│               │       │   └── UserServiceImpl.java   
│               │       ├── MdDownloadService.java   
│               │       ├── ProjectService.java   
│               │       ├── RegisterService.java   
│               │       └── UserService.java   
│               └── RssApplication.java   
└── resources   
    └── application.properties   
   
17 directories, 36 files   

Web API

HTTP	API	URL	Return Type	Parameters
MarkdownController.java
Post	makeMDzipFile()	/mdZipFile	byte[]	@RequestBody List<Map<String Object>> readme
UnzipController.java
Post	getFileData()	/register2	HashMap<String,Object>	@RequestParam("jsonParam1") String repoLink
Post	saveData()	/framework	String	@RequestParam("projectId") String projectId @RequestParam("frameworkName") String frameworkName
Post	editPeriodImage()	/editPeriod	String	@RequestParam("start_date") String startDate @RequestParam("end_date") String endDate
Post	allData()	/alldata	Map<String,String[]>	@RequestParam("projectId") String projectId

DB Table

🌱 Framework Table

Column Name
name (PK)
type
content

🌱 Project Table

Column Name
id (PK)
fileName (PK)
filePath (PK)
fileContent
detail

🌱 User Table

Column Name
projectId (PK)
userName
repositoryName

Dependencies

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <dependency>
        <groupId>org.mariadb.jdbc</groupId>
        <artifactId>mariadb-java-client</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-validation</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-configuration-processor</artifactId>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>commons-io</groupId>
        <artifactId>commons-io</artifactId>
        <version>2.1</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-test</artifactId>
    </dependency>
    <dependency>
        <groupId>org.jsoup</groupId>
        <artifactId>jsoup</artifactId>
        <version>1.14.2</version>
    </dependency>
</dependencies>

License

The MIT License (MIT)

Copyright (c) 2023 DevDachan

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Social

Contributor