diff --git a/README.md b/README.md index 907b774..2fb1d56 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ did-ta-server ├── libs └── did-sdk-common-1.0.0.jar └── did-blockchain-sdk-server-1.0.0.jar - └── did-core-sdk-server-1.0.0..jar + └── did-core-sdk-server-1.0.0.jar └── did-crypto-sdk-server-1.0.0.jar └── did-datamodel-sdk-server-1.0.0.jar └── did-wallet-sdk-server-1.0.0.jar @@ -42,35 +42,36 @@ did-ta-server └── src └── build.gradle └── README.md + └── README_ko.md ```
Below is a description of each folder and file in the directory: -| Name | Description | -| ----------------------- | ----------------------------------------------- | -| CHANGELOG.md | Version-specific changes in the project | -| CODE_OF_CONDUCT.md | Code of conduct for contributors | -| CONTRIBUTING.md | Contribution guidelines and procedures | -| LICENSE | License | -| dependencies-license.md | Licenses for the project’s dependency libraries | -| MAINTAINERS.md | Guidelines for project maintainers | -| RELEASE-PROCESS.md | Procedures for releasing new versions | -| SECURITY.md | Security policies and vulnerability reporting | -| docs | Documentation | -| ┖ api | API guide documentation | -| ┖ errorCode | Error codes and troubleshooting guides | -| ┖ installation | Installation and setup instructions | -| ┖ db | Database ERD, Table Specifications | -| source | Server source code project | -| ┖ did-ta-server | TAS Server source code and build files | -| ┖ gradle | Gradle build configurations and scripts | -| ┖ libs | External libraries and dependencies | -| ┖ sample | Sample files | -| ┖ src | Main source code directory | -| ┖ build.gradle | Gradle build configuration file | -| ┖ README.md | Overview and instructions for the source code | +| Name | Description | +| -------------------------------- | ----------------------------------------------- | +| CHANGELOG.md | Version-specific changes in the project | +| CODE_OF_CONDUCT.md | Code of conduct for contributors | +| CONTRIBUTING.md | Contribution guidelines and procedures | +| LICENSE | License | +| dependencies-license.md | Licenses for the project’s dependency libraries | +| MAINTAINERS.md | Guidelines for project maintainers | +| RELEASE-PROCESS.md | Procedures for releasing new versions | +| SECURITY.md | Security policies and vulnerability reporting | +| docs | Documentation | +| ┖ api | API guide documentation | +| ┖ errorCode | Error codes and troubleshooting guides | +| ┖ installation | Installation and setup instructions | +| ┖ db | Database ERD, Table Specifications | +| source | Server source code project | +| ┖ did-ta-server | TAS Server source code and build files | +|    ┖ gradle | Gradle build configurations and scripts | +|    ┖ libs | External libraries and dependencies | +|    ┖ sample | Sample files | +|    ┖ src | Main source code directory | +|    ┖ build.gradle | Gradle build configuration file | +|    ┖ README.md | Overview and instructions for the source code |
@@ -79,7 +80,7 @@ Below is a description of each folder and file in the directory: Libraries used in this project are organized into two main categories: -1. **Open DID Libraries**: These libraries are developed by the Open DID project and are available in the [libs folder](source/tas/libs). They include: +1. **Open DID Libraries**: These libraries are developed by the Open DID project and are available in the [libs folder](source/did-ta-server/libs). They include: - `did-sdk-common-1.0.0.jar` - `did-blockchain-sdk-server-1.0.0.jar` @@ -88,7 +89,7 @@ Libraries used in this project are organized into two main categories: - `did-datamodel-sdk-server-1.0.0.jar` - `did-wallet-sdk-server-1.0.0.jar` -2. **Third-Party Libraries**: These libraries are open-source dependencies managed via the [build.gradle](source/tas/build.gradle) file. For a detailed list of third-party libraries and their licenses, please refer to the [LICENSE-dependencies.md](LICENSE-dependencies.md) file. +2. **Third-Party Libraries**: These libraries are open-source dependencies managed via the [build.gradle](source/did-ta-server/build.gradle) file. For a detailed list of third-party libraries and their licenses, please refer to the [dependencies-license.md](dependencies-license.md) file. ## Installation And Operation Guide diff --git a/README_ko.md b/README_ko.md new file mode 100644 index 0000000..9235afa --- /dev/null +++ b/README_ko.md @@ -0,0 +1,120 @@ +TAS(Trust Agent Service) Server +== + +TAS 서버 Repository에 오신 것을 환영합니다.
+이 Repository는 TAS 서버의 소스 코드, 문서, 관련 리소스를 포함하고 있습니다. + +## 폴더 구조 +프로젝트 디렉터리 내 주요 폴더와 문서에 대한 개요: + +``` +did-ta-server +├── CHANGELOG.md +├── CLA.md +├── CODE_OF_CONDUCT.md +├── CONTRIBUTING.md +├── LICENSE +├── dependencies-license.md +├── MAINTAINERS.md +├── README.md +├── RELEASE-PROCESS.md +├── SECURITY.md +├── docs +│   └── api +│   └── TAS_API_ko.md +│   └── errorCode +│   └── TAS_ErrorCode.md +│   └── installation +│   └── OpenDID_TASServer_InstallationAndOperation_Guide.md +│   └── db +│   └── OpenDID_TableDefinition_TAS.md +└── source + └── did-ta-server + ├── gradle + ├── libs + └── did-sdk-common-1.0.0.jar + └── did-blockchain-sdk-server-1.0.0.jar + └── did-core-sdk-server-1.0.0..jar + └── did-crypto-sdk-server-1.0.0.jar + └── did-datamodel-sdk-server-1.0.0.jar + └── did-wallet-sdk-server-1.0.0.jar + ├── sample + └── src + └── build.gradle + └── README.md + └── README_ko.md +``` + +
+ +각 폴더와 파일에 대한 설명은 다음과 같습니다: + +| 이름 | 설명 | +| -------------------------------- | ---------------------------------------- | +| CHANGELOG.md | 프로젝트의 버전별 변경 사항 | +| CODE_OF_CONDUCT.md | 기여자 행동 강령 | +| CONTRIBUTING.md | 기여 지침과 절차 | +| LICENSE | 라이선스 | +| dependencies-license.md | 프로젝트 의존 라이브러리의 라이선스 정보 | +| MAINTAINERS.md | 프로젝트 유지 관리자 지침 | +| RELEASE-PROCESS.md | 새 버전 릴리스 절차 | +| SECURITY.md | 보안 정책 및 취약성 보고 방법 | +| docs | 문서화 | +| ┖ api | API 가이드 문서 | +| ┖ errorCode | 오류 코드 및 문제 해결 가이드 | +| ┖ installation | 설치 및 설정 지침 | +| ┖ db | 데이터베이스 ERD, 테이블 명세서 | +| source | 서버 소스 코드 프로젝트 | +| ┖ did-ta-server | TAS 서버 소스 코드 및 빌드 파일 | +|    ┖ gradle | Gradle 빌드 설정 및 스크립트 | +|    ┖ libs | 외부 라이브러리 및 종속성 | +|    ┖ sample | 샘플 파일 | +|    ┖ src | 주요 소스 코드 디렉터리 | +|    ┖ build.gradle | Gradle 빌드 설정 파일 | +|    ┖ README.md | 소스 코드 개요 및 지침 | + +
+ + +## 라이브러리 + +이 프로젝트에서 사용되는 라이브러리는 두 가지 주요 카테고리로 구성됩니다: + +1. **Open DID 라이브러리**: Open DID 프로젝트에서 개발된 라이브러리로, [libs 폴더](source/did-ta-server/libs)에 포함되어 있습니다. 주요 라이브러리는 다음과 같습니다: + + - `did-sdk-common-1.0.0.jar` + - `did-blockchain-sdk-server-1.0.0.jar` + - `did-core-sdk-server-1.0.0.jar` + - `did-crypto-sdk-server-1.0.0.jar` + - `did-datamodel-sdk-server-1.0.0.jar` + - `did-wallet-sdk-server-1.0.0.jar` + +2. **서드 파티 라이브러리**: 이 라이브러리들은 오픈 소스 종속성으로, [build.gradle](source/did-ta-server/build.gradle) 파일을 통해 관리됩니다. 서드 파티 라이브러리와 해당 라이선스의 자세한 목록은 [dependencies-license.md](dependencies-license.md) 파일을 참고하십시오. + +## 설치 및 운영 가이드 + +TA 서버의 설치 및 구성에 대한 자세한 지침은 아래 가이드를 참조하십시오: +- [OpenDID TAS 서버 설치 및 운영 가이드](docs/installation/OpenDID_TASServer_InstallationAndOperation_Guide.md) + +## API 참고 문서 + +- **TAS API**: TAS 서버의 API 엔드포인트 및 사용법에 대한 자세한 참고 자료입니다. + - [TAS API 참고 자료](docs/api/TAS_API_ko.md) + +## Change Log + +Change Log에는 버전별 변경 사항과 업데이트가 자세히 기록되어 있습니다. 다음에서 확인할 수 있습니다: +- [Change Log](./CHANGELOG.md) + +## OpenDID 시연 영상 + +OpenDID 시스템의 시연 영상을 보려면 [데모 Repository](https://github.com/OmniOneID/did-demo-server)를 방문하십시오.
+ +이 영상에서는 사용자 등록, VC 발급, VP 제출 프로세스 등 주요 기능을 시연합니다. + +## 기여 + +기여 절차와 행동 강령에 대한 자세한 내용은 [CONTRIBUTING.md](CONTRIBUTING.md)와 [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)를 참조해 주십시오. + +## 라이선스 +[Apache 2.0](LICENSE)