Skip to content

Commit

Permalink
docs: README 수정 및 기술문서 추가
Browse files Browse the repository at this point in the history
  • Loading branch information
0-wook committed Oct 30, 2023
1 parent 5ede385 commit c0225ca
Show file tree
Hide file tree
Showing 28 changed files with 8,199 additions and 11,185 deletions.
61 changes: 53 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,69 @@

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

![https://img.shields.io/github/workflow/status/wise-pangnem/WSAutoMLMainWeb/build](https://img.shields.io/github/workflow/status/wise-pangnem/WSAutoMLMainWeb/build)
![https://img.shields.io/github/workflow/status/wise-pangnem/WSAutoMLMainWeb/build](https://img.shields.io/github/workflow/status/0-wook/WSAutoMLMainWeb/build)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=wise-pangnem_AutoMLMainWeb&metric=coverage)](https://sonarcloud.io/summary/new_code?id=wise-pangnem_AutoMLMainWeb)

### 소개

AutoML은 날씨, 교통 관련 오픈 데이터를 제공하는 오픈 데이터 웹 플랫폼입니다.
---

### 사진
WS-AutoML은 클라우드 기반의 시계열 데이터 활용을 위한 오픈 데이터 제공 및 모델 학습·활용 서비스를 제공하는 통합 데이터 관리 플랫폼입니다.

어드민 서비스 메인 페이지
![admin-service-main-page.png](images/admin-service-main-page.png)
- 관리자 서비스 메인 페이지
![admin-service-main.png](images/admin-service-main.png)

사용자 서비스 메인 페이지
![user-service-main-page.png](images/user-service-main-page.png)
- 사용자 서비스 메인 페이지
![user-service-main.png](images/user-service-main.png)

### 주요 기능

---

- **관리자**

1. 메타데이터 관리

- 메타데이터 리스트
![admin-service-metadata-management.png](images/admin-service-metadata-management.png)
- 메타데이터 업로드
![admin-service-metadata-upload.png](images/admin-service-metadata-upload.png)

2. 사용자 권한 관리
![admin-service-user-management.png](images/admin-service-user-management.png)

- **사용자**

1. 메타데이터 검색 및 조회
![user-service-search.png](images/user-service-search.png)

![user-service-search-detail.png](images/user-service-search-detail.png)

- 조회한 데이터 미리보기 및 파일 다운로드 가능

2. 사용자별 모델 운용(모델 학습, 모델 활용)

- 모델 학습

- 사용할 데이터셋 선택
![user-service-model-learning-data-input.png](images/user-service-model-learning-data-input.png)
- 데이터 탐색 및 목표 변수 선택
![user-service-model-learning-data-navigation.png](images/user-service-model-learning-data-navigation.png)
- 특징 중요도에 따른 사용 변수 선택
![user-service-model-learning-feature-selection.png](images/user-service-model-learning-feature-selection.png)
- 알고리즘 선택 및 파라미터 설정 후 모델 생성
![user-service-model-learning-select-algorithm.png](images/user-service-model-learning-select-algorithm.png)

- 모델 운영
![user-service-model-operation.png](images/user-service-model-operation.png)

### 주요 기술

---


- React, Material UI
- React, Material UI, Ant Design

서버

Expand All @@ -40,4 +83,6 @@ AutoML은 날씨, 교통 관련 오픈 데이터를 제공하는 오픈 데이

### 기타

---

- [문서 목록](./docs)
46 changes: 0 additions & 46 deletions app/admin-web/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 0 additions & 2 deletions app/admin-web/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@
"@mui/x-data-grid": "^5.12.3",
"@testing-library/jest-dom": "^5.16.4",
"@testing-library/react": "^13.3.0",
"@testing-library/user-event": "^13.5.0",
"axios": "^0.27.2",
"cors": "^2.8.5",
"react": "^18.1.0",
"react-dom": "^18.1.0",
"react-google-button": "^0.7.2",
Expand Down
12 changes: 11 additions & 1 deletion app/admin-web/src/App.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import LoginPage from "./pages/LoginPage";
import HomePage from "./pages/HomePage";
import { AuthProvider } from "./components/authentication/AuthContext";
import PrivateRoute from "./components/authentication/PrivateRoute";
import AdminRoute from "./components/authentication/AdminRoute";

function PageTemplate() {
return (
Expand All @@ -19,7 +20,16 @@ function PageTemplate() {
<Route path='/Home' element={<HomePage />} />
<Route path='/metadata/*' element={<MetaDataPage />} />
<Route path='/user/*' element={<UserPage />} />
<Route path='/user-management/*' element={<UserPage />} />

<Route
path='/user-management/*'
element={
<AdminRoute>
<UserPage />
</AdminRoute>
}
/>

<Route path='*' element={<NotFound />} />
</Routes>
</PaperBase>
Expand Down
11 changes: 11 additions & 0 deletions app/admin-web/src/components/authentication/AdminRoute.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import React from "react";

import { useAuth } from "./AuthContext";
import Forbidden from "../../error/Forbidden";

function AdminRoute({ children }) {
const { user } = useAuth();
return user.role === "ADMIN" ? children : <Forbidden />;
}

export default AdminRoute;
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import React from "react";

import { Navigate } from "react-router-dom";
import { useAuth } from "./AuthContext";
import Forbidden from "../../error/Forbidden";

Expand Down
Loading

0 comments on commit c0225ca

Please sign in to comment.