[ALL/DOCS] README 작성

BE/README.md

@@ -5,10 +5,17 @@
 | Language, Framework | Java, Spring Boot |
 | Database | MySQL, Redis, Flyway |
 | ORM | Spring Data JPA, QueryDSL |
-| 운영 환경 구축 | ECR, ECS, EC2, Docker |
+| 운영 환경 구축 | EC2, Docker |
 | Build | Gradle |
 | CI/CD | Github Actions |
-| library | Spring Open Feign, OAuth 2.0 |
+| Library | Spring Open Feign, OAuth 2.0, Actuator |
+
+## 실행방법
+1. git clone
+2. 환경변수를 설정해줍니다.(env.properties)
+3. docker-compose를 통해 db를 실행합니다.
+4. spring boot를 실행합니다.
+
 
 ## docs
 [서브 도메인 적용하기](https://velog.io/@kssumin/%EC%84%9C%EB%B8%8C-%EB%8F%84%EB%A9%94%EC%9D%B8-%EC%A0%81%EC%9A%A9%ED%95%98%EA%B8%B0)
@@ -21,8 +28,3 @@
 
 [200 status code만 사용하지 말자](https://velog.io/@kssumin/EEOS-%EC%BA%90%EC%8B%B1)
 
-## 실행방법
-1. git clone
-2. 환경변수를 설정해줍니다.(env.properties)
-3. docker-compose를 통해 db를 실행합니다.
-4. spring boot를 실행합니다.

README.md

@@ -1,2 +1,90 @@
-# black-company
-BlackCompany팀의 에코노베이션 행사 관리 시스템 저장소입니다.
+![EEOS.png](https://github.com/kssumin/black-company-be/assets/88534959/5969a08a-9e10-4bb5-be76-1b538a1988f1)
+
+https://econo.eeos.store
+
+현재는 econovation 회원들만 서비스를 이용할 수 있습니다.
+
+## EEOS를 소개합니다.
+
+EEOS는 Econovation Event Operation System의 준말로, 전남대학교 IT 동아리 에코노베이션의 행사를 관리할 수 있는 체계입니다. EEOS를 통해 에코노베이션에서 진행하는 행사의 등록과 출석 여부 및 수요조사 등을 관리할 수 있습니다!
+
+### ⛳ **서비스 목표**
+
+에코노베이션뿐만 아니라 모든 동아리에는 여러가지 성격의 행사들이 존재합니다. 주로 행사의 출석 여부는 수기로 기록하거나, 수요조사는 카카오톡등으로 진행됩니다. 그렇지만 행사들이 계속해서 쌓이게 된다면, 출석 체크 관리는 어려워지고, 행사에 대한 정보들을 확인하기 어려워집니다.
+
+그래서 저희는 EEOS를 통해서 행사들을 체계적으로 관리하여서 동아리의 모든 행사들을 아카이빙할 수 있는 서비스를 만들게 되었습니다.
+
+- **EEOS’s Mission**
+    - 출석 체크 시스템 온라인화
+    - 행사 아카이빙
+- **EEOS’s Vision**
+    - 기존의 수기로 진행되었던 출석체크를 온라인으로 진행하여서, 사용자가 직접 자신의 출석 여부를 입력하여 출석체크를 하는 비용을 최소화하고, 이후 운영진(관리자)이 모든 행사들의 출석 여부를 빠르게 파악할 수 있게끔 한다.
+    - 이전까지의 모든 행사들을 서비스를 통해 아카이빙하여서 반복되는 행사들에 대한 방향성을 보다 빠르게 찾을 수 있게 돕는다.
+
+### 📄관련 문서
+
+- About EEOS
+- EEOS USER MANUAL
+- EEOS VOC
+- EEOS Update
+
+## 주요 기능을 소개합니다.
+
+### **📍**EEOS 1.0
+
+- 운영진(관리자) 전용 페이지로, 운영자가 회원들의 출석 여부를 입력합니다.
+    - 행사 조회
+    - 행사 생성 및 수정
+    - 행사 세부 정보 조회
+
+### **📍**EEOS 2.0
+
+- 모든 사용자가 직접 자신의 출석 여부를 입력할 수 있습니다.
+    - Slack OAuth 로그인
+    - 행사 조회 **+ 행사 카테고리화**
+    - 행사 생성 및 수정 **+ 수요 조사 기능**
+    - 행사 세부 정보 조회 **+ 출석 상태 입력**
+
+### **📍**EEOS 2.1
+
+- AI를 활용하여 팀빌딩을 진행하는 기능을 추가하였습니다.
+
+## 개발 팀 문서
+
+### Frontend Architecture
+![Frontend](https://github.com/kssumin/black-company-be/assets/88534959/c548d7fc-c6bc-4ecd-a152-1c8c8ce2e03c)
+
+### Backend Architecture
+![Backend](https://github.com/kssumin/black-company-be/assets/88534959/52122af3-95eb-4b40-94df-e51a9fc02b94)
+
+
+[AI - README.md](https://github.com/JNU-econovation/black-company/blob/main/AI/AI_README.md)
+
+[BE - README.md](https://github.com/JNU-econovation/black-company/tree/main/BE)
+
+[FE - README.md](https://github.com/JNU-econovation/black-company/blob/main/FE/README.md)
+
+[AOS - README.md](https://github.com/JNU-econovation/black-company/blob/main/AOS/README.md) 
+
+## Black Company를 소개합니다.
+
+### **팀원 소개**
+![Teams.png](https://github.com/kssumin/black-company-be/assets/88534959/60cd57f1-24a7-4c9c-a638-a4f6420e5464)
+
+
+### 일정 관리
+![Plan.png](https://github.com/kssumin/black-company-be/assets/88534959/15a10eae-4e57-4137-bb62-81281563fb62)
+
+
+### 회고
+
+- Term과 Sprint가 끝날때마다 회고를 진행하여 프로젝트의 개선점을 찾고, 더 나은 프로젝트가, 팀이 되기 위해 노력하였습니다.
+- [회고](https://www.notion.so/1616cafbb8e04a6490f959274a8616ea?pvs=4)
+
+### 🔗 해당 주제로 포스팅한 글
+
+- [Steve velog](https://velog.io/@joonsu25/Term2-EEOS-2.0-%EC%A7%84%EC%A7%9C-%EC%82%AC%EC%9A%A9%EC%9E%90%EB%A5%BC-%EC%96%BB%EB%8B%A4)
+
+### 🗣️발표자료
+
+- [2024 Econovation WINTER DEV](https://www.youtube.com/live/vVuFdP8J4n4?si=PRMTeW5yQMY8hg99&t=14886)