Skip to content

Commit

Permalink
chore: 문서 추가
Browse files Browse the repository at this point in the history
  • Loading branch information
hm-lee committed Feb 24, 2021
1 parent e93242d commit 84b17c5
Show file tree
Hide file tree
Showing 8 changed files with 696 additions and 2 deletions.
40 changes: 38 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,38 @@
# next-template
next!
<img src="https://i.imgur.com/8eykkWY.gif" width="400"/>

<br/>

<center><b>📮 넥스트 틀 버전:</b> 2021-Apeach-1.0.0</center>

<br/>
<br/>

# 📦 넥스트 템플릿 (next-template)

> 넥스트(Next.js) 를 사용하기 좋게하면서 가능한 **최신의 모듈 버전으로 관리하고 있는 예시 틀**입니다.
> 이 문서와 틀은 오직 **한국어로 한국 내 넥스트 이용자를 위해** 구성 & 관리되고 있습니다.😊 (<u>This document and template are organized and managed only for Next users in Korea.</u>)
<br/>

이 프로젝트는 다른 프로젝트를 개발할 때 사용하기 좋도록 가능한 빈 템플릿을 만들되 **설정들과 구조들을 잡아놓는 프로젝트로 제한된 일부 예시만을 가지고 있습니다.** 🤗

<br/>

## 🥳 문서 모음

> 문서를 기여해주시려면 `docs/` 에 md 파일을 작성해주시면 됩니다! [[작성방법]](https://github.com/AhaOfficial/next-template/tree/master/docs#-%EB%AC%B8%EC%84%9C-%EC%9E%91%EC%84%B1-%EB%B0%A9%EB%B2%95)
- [🤔 기초 설명](https://github.com/AhaOfficial/next-template/blob/master/docs/기초_설명.md)
- [📔 사용하는 주요 기술](https://github.com/AhaOfficial/next-template/blob/master/docs/사용하는_주요_기술.md)
- [👀 추천 강좌 목록](https://github.com/AhaOfficial/next-template/blob/master/docs/%EC%B6%94%EC%B2%9C_%EA%B0%95%EC%A2%8C_%EB%AA%A9%EB%A1%9D.md)
- [🛠 개발 환경 구성 방법](https://github.com/AhaOfficial/next-template/blob/master/docs/%EA%B0%9C%EB%B0%9C_%ED%99%98%EA%B2%BD_%EA%B5%AC%EC%84%B1_%EB%B0%A9%EB%B2%95.md)
- [⚗️ 실행/빌드/배포 방법](https://github.com/AhaOfficial/next-template/blob/master/docs/%EC%8B%A4%ED%96%89_%EB%B9%8C%EB%93%9C_%EB%B0%B0%ED%8F%AC_%EB%B0%A9%EB%B2%95.md)
- [🔬 기타 명령어 및 테스트 방법](https://github.com/AhaOfficial/next-template/blob/master/docs/%EA%B8%B0%ED%83%80_%EB%AA%85%EB%A0%B9%EC%96%B4_%EB%B0%8F_%ED%85%8C%EC%8A%A4%ED%8A%B8_%EB%B0%A9%EB%B2%95.md)

<br/>

## 🏷 저작권

MIT Licensed.

38 changes: 38 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<img src="https://i.imgur.com/8eykkWY.gif" width="400"/>

<br/>

[🧲 처음 페이지로 돌아가기](https://github.com/AhaOfficial/nuxt-template)

<br/>

# 📑 프로젝트 문서 모음

> 프로젝트와 관련된 여러 설명용 문서들이 여기에 담깁니다.
<br/>

## 📝 문서 형식 설명

> 이 프로젝트의 모든 문서들은 마크다운 (Markdown) 이라는 문서 규격을 통해 정의 됩니다. 확장자로는 `.md` 가 붙습니다. 폴더 경로에 `README.md` 라는 이름으로 문서를 작성해놓으면, 해당 문서는 깃허브에서 해당 경로로 접근할 때 아래에 기본 설명 문서로 출력됩니다.
- [마크다운 위키백과 소개](https://ko.wikipedia.org/wiki/%EB%A7%88%ED%81%AC%EB%8B%A4%EC%9A%B4)
- [마크다운 위키백과 소개](https://namu.wiki/w/%EB%A7%88%ED%81%AC%EB%8B%A4%EC%9A%B4)
- [마크다운 Gist 소개](https://gist.github.com/ihoneymon/652be052a0727ad59601)

<br/>

## 🖌 문서 작성 방법

> 마크다운은 문법으로 HTML 과 같이 일반 메모장으로도 작성할 수 있지만, 이렇게 작업하는 것은 너무 복잡하며, 권장되지 않습니다. 마크다운은 에디터를 통해서 쉽게 작성하실 수 있으니 꼭 에디터를 통해 작성 및 수정하시는 것을 권장드립니다.
마크다운 문서를 작성할 때에 `Typora` 라는 에디터를 이용하면 쉽게 마크다운 문서를 만들고 수정할 수 있습니다. (윈도우와 맥에서 작동하는 설치형 무료 에디터입니다.)

- [타이포라 공식 페이지 (영문)](https://typora.io/)
- [타이포라 사용법 Velog 강좌](https://velog.io/@hidaehyunlee/Typora%EB%A7%88%ED%81%AC%EB%8B%A4%EC%9A%B4-%EC%97%90%EB%94%94%ED%84%B0-%EC%82%AC%EC%9A%A9%EB%B2%95)
- [타이포라 사용법 유튜브 예시](https://youtu.be/0mdRlG4brEM)

<br/>

[🧲 처음 페이지로 돌아가기](https://github.com/AhaOfficial/nuxt-template)

94 changes: 94 additions & 0 deletions docs/개발_환경_구성_방법.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
<img src="https://i.imgur.com/8eykkWY.gif" width="400"/>



[🧲 처음 페이지로 돌아가기](https://github.com/AhaOfficial/nuxt-template)

<br/>

# 🛠 개발 환경 구성 방법

> 프로젝트를 개발하는데 필요한 환경을 구성하는 방법을 설명합니다.
<br/>

## 👩🏻‍💻 윈도우의 경우

> 사용하시는 OS가 윈도우인 경우 가장 먼저 이 작업을 진행해주세요.
윈도우의 경우 리눅스용 명령어 체계인 Bash 와 Git 을 반드시 꼭 설치해주어야합니다.

<br/>

- Git-SCM 설치

> Git-SCM에는 Git 과 Bash 가 모두 내장되어 있습니다.
https://gitforwindows.org/

> 위 프로그램을 설치하는 가이드 https://uxgjs.tistory.com/165
<br/>

- WSL 설치

> Git-SCM 안에 Bash 가 동봉되어 있어서 WSL 은 필수는 아니지만, WSL 은 윈도우에서 공식적으로 지원하는 리눅스 지원용 하위 시스템 체계이므로 이를 가능하다면 사용하는 것도 좋습니다.
https://docs.microsoft.com/ko-kr/windows/wsl/install-win10

<br/>

## 🔮 공통적인 진행 사항

- Node.JS 설치

> 안정적인 사용을 원한다면 LTS 버전을, 최신기능을 먼저 사용해보고 싶으시다면 현재버전을 설치해주세요.
https://nodejs.org/ko/

<br/>

<img src="https://user-images.githubusercontent.com/1271146/47272399-00738880-d57d-11e8-9de6-0a6b86df7dac.png" width="600"/>

<br/>

> 노드 JS 설치 시 가능한 반드시 꼭 **Auto matically install the necessary tools.** 에 체크해주세요. C++ 모듈을 빌드하는데 필요한 환경설정을 자동으로 해줍니다.
<br/>

## ⚗️ VSCode 설치

> 이 프로젝트에서는 VSCode 를 사용하는 것을 추천드리고 있습니다.
VSCode 는 Microsoft 에서 출시한 다양한 개발자들을 위한 가벼운 IDE 입니다. 타입스크립트에 대한 강력한 지원과 함께 여러 기능들을 익스텐션 형태로 이용자가 개발해서 배포할 수 있도록 하고 있습니다.

- [VSCode 설치 URL](https://code.visualstudio.com/)

<br/>

### 📦 VSCode Extension 추천

- [Better Comments - 주석의 중요도에 따라 색상을 입힐 수 있게 해줍니다. (강력 추천)](https://marketplace.visualstudio.com/items?itemName=aaron-bond.better-comments)
- [Todo Tree - 주석으로 TODO 를 작성해놓으면 프로젝트에 있는 투두 주석들을 모아 보여줍니다. (강력추천)](https://github.com/Gruntfuggly/todo-tree)
- [Path Autocomplete - 문자열로 경로를 사용하게 되면 경로를 자동완성해줍니다.](https://marketplace.visualstudio.com/items?itemName=ionutvmi.path-autocomplete)
- [Version Lens - 각 모듈에 대한 package.json 에서 최신 버전을 확인할 수 있게 해줍니다.](https://marketplace.visualstudio.com/items?itemName=pflannery.vscode-versionlens)
- [TailwindCSS-Intellisense - 테일윈드 CSS 클래스들을 VSCode 에서 자동완성해줍니다.](https://github.com/tailwindlabs/tailwindcss-intellisense)
- [GitHub Pull Requests and Issues - 깃허브 이슈와 PR을 VScode 에서 다룰 수 있게 해줍니다.](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github)
- [DotENV - `.env` 파일을 편집하기 편하게 하이라이팅을 추가해줍니다.](https://marketplace.visualstudio.com/items?itemName=mikestead.dotenv)

<br/>

## 🎚 부가적인 진행 사항

- Sourcetree 설치

> Git 을 GUI 를 통해서 관리할 수 있게 해주는 전문 Git 툴입니다.
https://www.sourcetreeapp.com/

> 위 프로그램을 설치하고 사용하는 가이드 https://uxgjs.tistory.com/181
<br/>

[🧲 처음 페이지로 돌아가기](https://github.com/AhaOfficial/nuxt-template)

Loading

0 comments on commit 84b17c5

Please sign in to comment.