Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
67e2b71
docs: update README.md
wmakerjun Dec 15, 2020
07cf529
first commit
intae92 Dec 19, 2020
00b3e74
docs: README 기능구현목록 업데이트
intae92 Dec 19, 2020
c892d25
feat: 지하철 역, 노선 데이터 설정
intae92 Dec 19, 2020
5566f46
feat: View 클래스 구현
intae92 Dec 19, 2020
41cf28f
feat: App 초기화 세팅
intae92 Dec 19, 2020
3333b89
feat: form 렌더링
intae92 Dec 19, 2020
85a65ee
feat: DOM id값 변수 상수화
intae92 Dec 19, 2020
3d89fc9
feat: 입력된 역 이름 유효성 판단
intae92 Dec 19, 2020
cca3747
feat: 출발역, 도착역 서로 다른 값 유무 판단
intae92 Dec 19, 2020
b10a727
feat: 출발역, 도착역 연결되어 있는지 판단
intae92 Dec 19, 2020
59f5584
feat: 잘못된 입력값 input 태그 reset
intae92 Dec 19, 2020
a1d42a0
feat: 최소, 최단 거리 radio 객체 생성
intae92 Dec 19, 2020
781855e
feat: 선택된 radio value 값 구하기
intae92 Dec 19, 2020
5ada698
style: radio value 네이밍 변경
intae92 Dec 19, 2020
59d3d95
feat: 최단거리 결과 구하기
intae92 Dec 19, 2020
4c35a1e
feat: table 렌더링
intae92 Dec 19, 2020
a138c3a
feat: 테이블 렌더링 결과 노선 리스트 부분
intae92 Dec 19, 2020
782a9b2
feat: 새로운 결과 테이블 렌더링 위해 이전 테이블 지우기
intae92 Dec 19, 2020
d076197
feat: 총 거리, 총 소요시간 구하기
intae92 Dec 19, 2020
08aad3c
feat: 계산 구하기 break 설정
intae92 Dec 19, 2020
b3fbc85
docs: README 업데이트
intae92 Dec 19, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion README.md

This file was deleted.

218 changes: 218 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,218 @@
# 구현할 기능 목록

## 초기 설정

- [x] 데이터 초기 설정

## 경로 조회 기능

### 입력

- [x] 출발역을 입력 받아야 한다
- [x] 도착역을 입력 받아야 한다
- [x] ! 입력 값이 역 데이터에 있어야 한다
- [x] ! 두 글자 이상
- [x] 잘못된 입력시 input 태그 reset
- [x] 선택된 radio value 구하기

### 경로 조회

- [x] ! 출발역, 도착역 같을 수 없다
- [x] ! 출발역과 도착역이 연결 되어 있어야 한다

### 에러 출력

- [x] alert 에러 출력

## 프로젝트 구조

```sh
.
├── docs
│ └── README.md
├── images
│ ├── dijkstra_example.png
│ ├── path_result.gif
│ └── path_result.jpg
├── index.html
└── src
├── app.js
├── controllers
│ └── MainController.js
├── models
│ └── data.js
├── styles
│ └── global.css
├── utils
│ ├── Dijkstra.js
│ └── constants.js
└── views
├── ArrivalStationView.js
├── DepartureStationView.js
├── FormView.js
├── ResultTable.js
├── View.js
├── minimumRadioView.js
└── shortestRadioView.js
```

# 🚇 지하철 노선도 경로 조회 미션

- 등록된 지하철 노선도에서 경로를 조회하는 기능을 구현한다.

## 🚀 기능 요구사항

> 프리코스 3주차 미션에서 사용한 코드를 참고해도 무관하다.

### 초기 설정

- 프로그램 시작 시 역, 노선, 구간 데이터를 초기 설정 해야 한다.
- 거리와 소요 시간은 양의 정수이며 단위는 km와 분을 의미한다.
- 아래의 사전 등록 정보로 반드시 초기 설정을 한다.

```
1. 지하철역으로 교대, 강남, 역삼, 남부터미널, 양재, 양재시민의숲, 매봉 역 정보가 등록되어 있다.
2. 지하철 노선으로 2호선, 3호선, 신분당선이 등록되어 있다.
3. 노선에 역이 아래와 같이 등록되어 있다.(왼쪽 끝이 상행 종점)
- 2호선: 교대 - ( 2km / 3분 ) - 강남 - ( 2km / 3분 ) - 역삼
- 3호선: 교대 - ( 3km / 2분 ) - 남부터미널 - ( 6km / 5분 ) - 양재 - ( 1km / 1분 ) - 매봉
- 신분당선: 강남 - ( 2km / 8분 ) - 양재 - ( 10km / 3분 ) - 양재시민의숲
```

### 경로 조회 기능

<img src="/images/path_result.jpg" width="100%">

- 출발역과 도착역을 입력받아 경로를 조회한다.
- 경로 조회 시 총 거리, 총 소요 시간을 함께 출력한다.
- 경로 조회 시 `최단 거리` 또는 `최소 시간` 옵션을 선택할 수 있다.

### 예외 처리

- 출발역과 도착역은 2글자 이상이어야 한다.
- 존재하지 않는 역을 출발역 또는 도착역으로 입력할 수 없다.
- 경로 조회 시 출발역과 도착역이 같을 수 없다.
- 경로 조회 시 출발역과 도착역이 연결되지 않으면 경로를 조회할 수 없다.
- 그 외 정상적으로 프로그램이 수행되지 않은 경우 `alert`으로 에러를 출력한다.

<br>

## 💻 프로그래밍 실행 결과

### 경로 조회

<img src="/images/path_result.gif" width="100%">

## ✅ 프로그래밍 요구사항

### 길찾기 관련 기능

- 출발역을 입력하는 input 태그는 `departure-station-name-input` id 속성값을 가진다.
- 도착역을 입력하는 input 태그는 `arrival-station-name-input` id 속성값을 가진다.
- 최단거리, 최소시간을 선택하는 radio는 `search-type` name 속성값을 가진다.
- **radio option의 default 값은 최단거리이다.**
- 길찾기 버튼은 `search-button` id 속성값을 가진다.
- 📝 결과는 `table`을 이용하여 보여준다.

## ❗️힌트

## 데이터 초기화

자바스크립트에서 데이터를 초기화하는 방법 중에 하나는 아래와 같이 data를 `export`하고, `import`하는 것이다.

```javascript
export const users = [
{
name: "Alt",
},
{
name: "Jamie",
},
{
name: "Sony",
},
];

export const courses = [
{
name: "frontend",
},
{
name: "backend",
},
{
name: "iOS",
},
{
name: "Android",
},
];
```

위와 같이 데이터를 `export`하면 아래와 같이 데이터를 `import` 하여 사용할 수 있다.

```javascript
import { users, courses } from "./data.js";

function App() {
this.users = users;
this.courses = courses;
}
```

## 최단 경로 라이브러리

- `utils/Dijkstra.js` 라이브러리를 활용하면 간편하게 최단거리를 조회할 수 있다.
- 정점(Vertex)과 간선(Edge), 그리고 가중치 개념을 이용
- 정점: 지하철역
- 간선: 지하철역 연결정보
- 가중치: 거리 or 소요 시간
- 최단 거리 기준 조회 시 가중치를 거리로 설정
- 최소 시간 기준 조회 시 가중치를 시간으로 설정

```javascript
import Dijkstra from "./utils/Dijkstra.js";
const dijkstra = new Dijkstra();

//dijkstra.addEdge("출발역", "도착역", 거리 또는 시간);
dijkstra.addEdge("V1", "V2", 2);
dijkstra.addEdge("V2", "V3", 2);
dijkstra.addEdge("V1", "V3", 100);

const result = dijkstra.findShortestPath("V1", "V3");
// result = ["V1", "V2", "V3"]
```

#### 테스트설명

<img src="/images/dijkstra_example.png" width="400">

- 역 사이의 거리를 고려하지 않는 경우 V1->V3 경로가 최단 경로
- 역 사이의 거리를 고려할 경우 V1->V3 경로의 거리는 100km, V1->V2->V3 경로의 거리는 4km이므로 최단 경로는 V1->V2->V3

<br>

### 요구사항

- 사용자가 잘못된 입력 값을 작성한 경우 `alert`을 이용해 메시지를 보여주고, 재입력할 수 있게 한다.
- 외부 라이브러리(jQuery, Lodash 등)를 사용하지 않고, 순수 Vanilla JS로만 구현한다.
- **자바스크립트 코드 컨벤션을 지키면서 프로그래밍** 한다
- [https://google.github.io/styleguide/jsguide.html](https://google.github.io/styleguide/jsguide.html)
- [https://ui.toast.com/fe-guide/ko_CODING-CONVENSION/](https://ui.toast.com/fe-guide/ko_CODING-CONVENTION)
- **indent(인덴트, 들여쓰기) depth를 3이 넘지 않도록 구현한다. 2까지만 허용**한다.
- 예를 들어 while문 안에 if문이 있으면 들여쓰기는 2이다.
- 힌트: indent(인덴트, 들여쓰기) depth를 줄이는 좋은 방법은 함수(또는 메소드)를 분리하면 된다.
- **함수(또는 메소드)의 길이가 15라인을 넘어가지 않도록 구현한다.**
- 함수(또는 메소드)가 한 가지 일만 잘 하도록 구현한다.
- 변수 선언시 [var](https://developer.mozilla.org/ko/docs/Web/JavaScript/Reference/Statements/var) 를 사용하지 않는다. [const](https://developer.mozilla.org/ko/docs/Web/JavaScript/Reference/Statements/const) 와 [let](https://developer.mozilla.org/ko/docs/Web/JavaScript/Reference/Statements/let) 을 사용한다.
- [import](https://developer.mozilla.org/ko/docs/Web/JavaScript/Reference/Statements/import) 문을 이용해 스크립트를 모듈화하고 불러올 수 있게 만든다.
- [template literal](https://developer.mozilla.org/ko/docs/Web/JavaScript/Reference/Template_literals)을 이용해 데이터와 html string을 가독성 좋게 표현한다.

<br/>

## 📝 미션 저장소 및 진행 요구사항

- 미션은 [https://github.com/woowacourse/javascript-subway-path-precourse](https://github.com/woowacourse/javascript-subway-path-precourse) 저장소를 fork/clone해 시작한다.
- **기능을 구현하기 전에 javascript-subway-path-precourse/docs/README.md 파일에 구현할 기능 목록**을 정리해 추가한다.
- **git의 commit 단위는 앞 단계에서 README.md 파일에 정리한 기능 목록 단위로 추가**한다.
- [프리코스 과제 제출](https://github.com/woowacourse/woowacourse-docs/tree/master/precourse) 문서 절차를 따라 미션을 제출한다.
Binary file added images/dijkstra_example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/path_result.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/path_result.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>지하철 길찾기</title>
<link rel="stylesheet" href="./src/styles/global.css" />
</head>
<body>
<div id="app"></div>
<script type="module" src="./src/app.js"></script>
</body>
</html>
17 changes: 17 additions & 0 deletions src/app.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import MainController from "./controllers/MainController.js";

class App {
constructor() {
this.tag = "[App]";
this.MainController = new MainController();
this.init();
}

init() {
document.addEventListener("DOMContentLoaded", () => {
this.MainController.init();
});
}
}

new App();
Loading