KauBoard, 한국항공대 학생들을 위한 크롬 익스텐션

완성 이미지

목차

• 프로젝트 설명
  • 사용 기술
  • 기여 준비사항
• 프로젝트 실행
• 프로젝트 로드맵
• 기여 방법
• 기여자 목록
• 프로젝트 저장소

프로젝트 설명

이 프로젝트는 한국항공대 학생들을 위한 다양한 편의기능이 내장된 크롬 익스텐션을 제작하는 것이 목표입니다.

사용 기술

이 프로젝트는 React.js 라이브러리를 통해 제작되었으며, API 서버는 Node.js와 express 프레임워크를 사용해 제작할 예정입니다. 또한 '새 탭에 페이지 덮어쓰기' 기능 및 테스트를 위해 크롬 익스텐션 개발 API를 활용합니다.

• React.js
• Node.js
• Chrome Development API

기여 준비사항

프로젝트 테스트 및 기여를 위한 소프트웨어를 기술합니다.

• Git
• React.js - ^17.0.1
• Node.js - Node.js 버전 6 이상 (12 또는 14버전 권장)
• Chrome Browser

프로젝트 실행

프로젝트를 로컬 환경에서 테스트하기 위한 방법을 기술합니다. (익스텐션 테스트방법 추가 예정)

1. 프로젝트 포크 후 클론

git clone https://github.com/유저네임/KAUBOARD.git

2. 의존성 파일 설치

npm install

3. 브라우저 환경에서 테스트 (주로 사용)

npm start

4. 익스텐션 환경에서 테스트 (최종 PR 전 필수)

npm build

프로젝트 로드맵

앞으로 개발할 기능들에 대한 내용을 기술합니다. (추가 예정)

• 일반공지, 학사공지
• 화전 날씨
• 진입중인 전철 정보
• 학교 주요 페이지 바로가기
• 자주 접속하는 링크 추가
• 건의사항 제출
• 시계
• 기말고사 등 주요 이벤트 D-Day, 종강까지 남은 날짜 알림

기여 방법

프로젝트에 기여할 수 있는 방법에 대해 기술합니다. (추가 예정)
기여자 슬랙 채널 링크

기여자 목록

• @c17an
• @bullgom

프로젝트 저장소 링크

Project Link: https://github.com/Korea-Aerospace-University/KAUBOARD