From 3b93c96c3eaface87e49b67cba6a8d1a5079f215 Mon Sep 17 00:00:00 2001 From: Seo Yeon Park Date: Mon, 18 Dec 2023 16:21:17 +0900 Subject: [PATCH] docs: Update README.md --- README.md | 310 ++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 240 insertions(+), 70 deletions(-) diff --git a/README.md b/README.md index 58beeac..3f002b0 100644 --- a/README.md +++ b/README.md @@ -1,70 +1,240 @@ -# Getting Started with Create React App - -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). - -## Available Scripts - -In the project directory, you can run: - -### `npm start` - -Runs the app in the development mode.\ -Open [http://localhost:3000](http://localhost:3000) to view it in your browser. - -The page will reload when you make changes.\ -You may also see any lint errors in the console. - -### `npm test` - -Launches the test runner in the interactive watch mode.\ -See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. - -### `npm run build` - -Builds the app for production to the `build` folder.\ -It correctly bundles React in production mode and optimizes the build for the best performance. - -The build is minified and the filenames include the hashes.\ -Your app is ready to be deployed! - -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. - -### `npm run eject` - -**Note: this is a one-way operation. Once you `eject`, you can't go back!** - -If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. - -Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own. - -You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it. - -## Learn More - -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). - -To learn React, check out the [React documentation](https://reactjs.org/). - -### Code Splitting - -This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting) - -### Analyzing the Bundle Size - -This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size) - -### Making a Progressive Web App - -This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) - -### Advanced Configuration - -This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration) - -### Deployment - -This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment) - -### `npm run build` fails to minify - -This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify) +# (주)플래디 사내 관리 페이지 Web +
+![7](https://github.com/PLADI-ALM/PLADI-ALM-Web/assets/62008784/13ca8486-13cb-4d09-8668-c3221f6b06b6) + +## Tech Stack +### Web + + + + + + +### Deploy + + + +### Develop Tool + + + + +### Etc. + + +
+ +## Project Architecture +![image](https://github.com/PLADI-ALM/PLADI-ALM-Web/assets/62008784/eb4db699-8420-4dbd-a3b3-523761cea49d) + +
+ +## Project Structure + +
+Details + +```jsx +src + ┣ api + ┃ ┗ AxiosApi.js + ┣ assets + ┃ ┣ fonts + ┃ ┃ ┣ font.css + ┃ ┃ ┣ NanumSquare_acB.woff + ┃ ┃ ┣ NanumSquare_acEB.woff + ┃ ┃ ┣ NanumSquare_acL.woff + ┃ ┃ ┗ NanumSquare_acR.woff + ┃ ┗ images + ┃ ┃ ┣ button + ┃ ┃ ┣ sidebarIcon + ┃ ┃ ┃ ┣ AdminActive.svg + ┃ ┃ ┃ ┣ AdminInactive.svg + ┃ ┃ ┃ ┣ ArchivingActive.svg + ┃ ┃ ┃ ┣ ArchivingInactive.svg + ┃ ┃ ┃ ┣ BookingActive.svg + ┃ ┃ ┃ ┣ BookingInactive.svg + ┃ ┃ ┃ ┣ EquipmentActive.svg + ┃ ┃ ┃ ┣ EquipmentInactive.svg + ┃ ┃ ┃ ┣ LogoutIcon.svg + ┃ ┃ ┃ ┣ MyBookingActive.svg + ┃ ┃ ┃ ┣ MyBookingInactive.svg + ┃ ┃ ┃ ┣ MyInfoIcon.svg + ┃ ┃ ┃ ┣ ToggleActive.svg + ┃ ┃ ┃ ┗ ToggleInactive.svg + ┃ ┃ ┣ arrowDown.svg + ┃ ┃ ┣ EmptyImg.svg + ┃ ┃ ┣ imgLogo.svg + ┃ ┃ ┣ imgNameLogo.svg + ┃ ┃ ┣ kor_nameLogo.svg + ┃ ┃ ┣ Location.svg + ┃ ┃ ┣ moreIcon.svg + ┃ ┃ ┣ RangeArrow.svg + ┃ ┃ ┣ Search.svg + ┃ ┃ ┣ SearchInput.svg + ┃ ┃ ┣ SearchPlus.svg + ┃ ┃ ┣ SelectArrow.svg + ┃ ┃ ┣ triple_dot_icon.svg + ┃ ┃ ┗ triple_dot_icon_black.svg + ┣ components + ┃ ┣ booking + ┃ ┃ ┗ StatusTag.js + ┃ ┣ button + ┃ ┃ ┣ BigSquareButton.js + ┃ ┃ ┣ ImageFullButton.js + ┃ ┃ ┣ ImagePaddingButton.js + ┃ ┃ ┗ SmallButton.js + ┃ ┣ capsule + ┃ ┃ ┣ Capsule.js + ┃ ┃ ┣ DropBox.js + ┃ ┃ ┣ FacilityCapsule.js + ┃ ┃ ┗ RoleCapsule.js + ┃ ┣ card + ┃ ┃ ┣ Card.js + ┃ ┃ ┣ EquipmentInfo.js + ┃ ┃ ┣ OfficeInfo.js + ┃ ┃ ┣ ResourceDetailInfo.js + ┃ ┃ ┗ ResourceInfo.js + ┃ ┣ modal + ┃ ┃ ┣ BigModal.js + ┃ ┃ ┣ BookingInfoModal.js + ┃ ┃ ┣ CarReturnModal.js + ┃ ┃ ┣ EquipmentMoreModal.js + ┃ ┃ ┣ MoreModal.js + ┃ ┃ ┣ ResourceReturnModal.js + ┃ ┃ ┣ UserModal.js + ┃ ┃ ┗ UserMoreModal.js + ┃ ┣ officeBooking + ┃ ┃ ┣ BookedTimeBar.js + ┃ ┃ ┣ BookingOfficeInfo.js + ┃ ┃ ┣ BookingPurpose.js + ┃ ┃ ┣ BookingTimeBar.js + ┃ ┃ ┗ SubTitleBar.js + ┃ ┣ resourceBooking + ┃ ┃ ┗ TimeSelector.js + ┃ ┣ rightContainer + ┃ ┃ ┗ RightContainer.js + ┃ ┣ searchBar + ┃ ┃ ┣ ManageSearchBar.js + ┃ ┃ ┗ SearchBar.js + ┃ ┣ sidebar + ┃ ┃ ┣ MainMenu.js + ┃ ┃ ┣ MenuLineStyle.js + ┃ ┃ ┣ Sidebar.js + ┃ ┃ ┗ SubMenu.js + ┃ ┗ toggle + ┃ ┃ ┗ Toggle.js + ┣ constants + ┃ ┣ BookingStatus.js + ┃ ┣ Path.js + ┃ ┗ ToggleList.js + ┣ pages + ┃ ┣ admin + ┃ ┃ ┣ car + ┃ ┃ ┃ ┣ CarManage.js + ┃ ┃ ┃ ┣ CarManageAdd.js + ┃ ┃ ┃ ┣ CarManageDetail.js + ┃ ┃ ┃ ┗ CarManageTableCell.js + ┃ ┃ ┣ carBookings + ┃ ┃ ┃ ┣ CarBookingManage.js + ┃ ┃ ┃ ┗ CarBookingManageCell.js + ┃ ┃ ┣ office + ┃ ┃ ┃ ┣ OfficeManage.js + ┃ ┃ ┃ ┣ OfficeManageAdd.js + ┃ ┃ ┃ ┣ OfficeManageDetail.js + ┃ ┃ ┃ ┗ OfficeManageTableCell.js + ┃ ┃ ┣ officeBookings + ┃ ┃ ┃ ┣ OfficeBookingManage.js + ┃ ┃ ┃ ┗ OfficeBookingManageCell.js + ┃ ┃ ┣ resource + ┃ ┃ ┃ ┣ ResourceManage.js + ┃ ┃ ┃ ┣ ResourceManageAdd.js + ┃ ┃ ┃ ┣ ResourceManageDetail.js + ┃ ┃ ┃ ┗ ResourceManageTableCell.js + ┃ ┃ ┣ resourceBookings + ┃ ┃ ┃ ┣ ResourceBookingManage.js + ┃ ┃ ┃ ┗ ResourceBookingManageCell.js + ┃ ┃ ┗ user + ┃ ┃ ┃ ┣ UserManage.js + ┃ ┃ ┃ ┗ UserManageLine.js + ┃ ┗ basic + ┃ ┃ ┣ booking + ┃ ┃ ┃ ┣ car + ┃ ┃ ┃ ┃ ┣ CarBooking.js + ┃ ┃ ┃ ┃ ┣ CarBookingCheck.js + ┃ ┃ ┃ ┃ ┗ SelectCar.js + ┃ ┃ ┃ ┣ office + ┃ ┃ ┃ ┃ ┣ OfficeBooking.js + ┃ ┃ ┃ ┃ ┣ OfficeBookingCheck.js + ┃ ┃ ┃ ┃ ┗ SelectOffice.js + ┃ ┃ ┃ ┗ resource + ┃ ┃ ┃ ┃ ┣ CustomCalendar.css + ┃ ┃ ┃ ┃ ┣ ResourceBooking.js + ┃ ┃ ┃ ┃ ┣ ResourceBookingCheck.js + ┃ ┃ ┃ ┃ ┗ SelectResource.js + ┃ ┃ ┣ equipment + ┃ ┃ ┃ ┣ EquipmentAdd.js + ┃ ┃ ┃ ┗ EquipmentList.js + ┃ ┃ ┣ myBookings + ┃ ┃ ┃ ┣ BookedLine.js + ┃ ┃ ┃ ┗ BookedList.js + ┃ ┃ ┗ user + ┃ ┃ ┃ ┣ EmailCheck.js + ┃ ┃ ┃ ┣ Login.js + ┃ ┃ ┃ ┗ ResetPassword.js + ┣ utils + ┃ ┣ CookiesUtil.js + ┃ ┣ ErrorHandlerUtil.js + ┃ ┣ ImageUtil.js + ┃ ┗ IsLoginUtil.js + ┣ App.css + ┣ App.js + ┣ App.test.js + ┣ index.css + ┣ index.js + ┣ reportWebVitals.js + ┗ setupTests.js +``` +
+
+ +## Commit/PR Convention +**Commit** +``` +[PDW-1] feat: 회의실 예약 UI +``` +- [지라티켓] 커밋 태그: 커밋 설명 +
+ +**Pull Request** +``` +[PDW-1/feat] 회의실 예약 +``` +- [지라티켓/커밋태그] 설명 +
+ +## Branch Strategy +- main + - 배포 이력 관리 목적 +- develop + - feat 병합용 브랜치 + - 배포 전 병합 브랜치 +- feat + - develop 브랜치를 베이스로 기능별로 feat 브랜치 생성해 개발 +- test + - 테스트가 필요한 코드용 브랜치 +- fix + - 배포 후 버그 발생 시 버그 수정 +
+ +- feat branch의 경우, feat/지라티켓-기능설명 형태로 작성 +```md +feat/PDW-1-office-booking +``` +
+ +## Member +|[박서연](https://github.com/psyeon1120)|[차유상](https://github.com/chayoosang)|[김초원](https://github.com/ryr0121)| +|:---:|:---:|:---:| +|||| +| **Web Architecture**| **Web Developer** | **Web Developer** |