Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sseohalee committed Jun 12, 2024
1 parent 3b4fe64 commit a9e1986
Showing 1 changed file with 47 additions and 22 deletions.
69 changes: 47 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,55 @@
# React + TypeScript + Vite
<div style="text-align: center;">
<img src="https://github.com/HanaPiece/hana-piece-client/assets/74031550/308674b4-bbfb-442c-9ef8-79c8ed6afbd3" style="margin: 0 auto; width:80%;" />
</div>

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
<br />
<br />

Currently, two official plugins are available:
# 🏦 하나피스 (Hana-Piece)

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh

## Expanding the ESLint configuration
> **" 인생주기 로드맵, 자동화 자산관리 서비스 "**
>
> Digital Hana 路 3기 금융 서비스 개발과정 두 번째 프로젝트입니다.
> + 개발 기간 : 2024. 5. 10 ~ 6. 11
If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
<br />

- Configure the top-level `parserOptions` property like this:
## 1. 프로젝트 소개
AI 기반의 자산관리 서비스 **하나피스**에서,
차, 결혼, 집 등 다양한 목표를 한 번에 관리할 수 있어요.
통장 쪼개기를 통해 자산 관리를 도와주고,
목표 달성을 위한 적금을 추천해드립니다.

```js
export default {
// other rules...
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
project: ['./tsconfig.json', './tsconfig.node.json'],
tsconfigRootDir: __dirname,
},
}
```
[하나피스_프로젝트_기획서](https://github.com/user-attachments/files/15784531/_.pdf)
[하나피스_화면기획서](https://github.com/user-attachments/files/15784544/_.pdf)

- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
###

## 2. 개발자 소개
| **도승희** | **이서하** |
|:---:|:---:|
|[도승희](https://github.com/doSeung11)|[이서하](https://github.com/sseohalee)|
|프론트엔드 팀장||
<br>

## 3. 시스템 구성도
![image](https://github.com/HanaPiece/hana-piece-server/assets/31121731/c1675b1b-074a-4343-913a-1be0093a42b4)

## 4. 개발 환경
- Version : Java 17
- IDE : IntelliJ
- Framework : SpringBoot 3.2.5
- Dependencies : JPA, QueryDSL, Spring security, jsonwebtoken, lombok, gson, jackson-databind-nullable

## 5. 주요 기능
- 목표 관리 - 목표 등록 및 목표 달성을 위한 상품 추천
- 계좌 관리 - 계좌 생성 및 관리
- 통장 쪼개기 - 사용 목적 별 통장 쪼개기 및 자동이체
- 상품 관리 - 상품 가입 및 자동이체

## 6. ERD
![image](https://github.com/HanaPiece/hana-piece-server/assets/31121731/1b318b10-e775-4dbc-af9d-0e18b962b5b1)

## License
[MIT](https://choosealicense.com/licenses/mit/)

0 comments on commit a9e1986

Please sign in to comment.