|
| 1 | +# 📖 (서비스 타이틀) |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | +- 배포 URL : (왠만하면 GitHub Pages로 정적 사이트 배포) |
| 8 | + |
| 9 | +<br> |
| 10 | + |
| 11 | +## 프로젝트 소개 |
| 12 | + |
| 13 | +- Blockchain 관련 내용 정리 |
| 14 | +- Obsidian 기반, Quartz 정적 사이트 배포 |
| 15 | + - 마크다운 다루기 어려우면 `Notion` 사용해서 복붙하기 |
| 16 | + |
| 17 | +<br> |
| 18 | + |
| 19 | +## Contributors |
| 20 | + |
| 21 | +### Powershell |
| 22 | + |
| 23 | +```powershell |
| 24 | +Invoke-Expression (Invoke-WebRequest -Uri "https://gist.githubusercontent.com/ooMia/d44748600e94b0366ec65398125b9c45/raw/1b19a22a19bb1c4c308d634757d435875d46c331/get_github_avatar.ps1").Content |
| 25 | +``` |
| 26 | + |
| 27 | +### sh/bash |
| 28 | + |
| 29 | +```bash |
| 30 | +sh <(curl -s "https://gist.githubusercontent.com/ooMia/afbae4f3249609e0bf17e4b6c7baa696/raw/ada8812c56d056dc15f71fc6973bdf501ea0a6f0/get_github_avatar.sh") |
| 31 | +``` |
| 32 | + |
| 33 | +| Option #1: GitHub-Profile <br/> oomia | Option #2: Local-Profile <br/> mia | |
| 34 | +| :--------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------: | |
| 35 | +| [<img src="https://avatars.githubusercontent.com/u/96914905" height=150 width=150> <br/> @GitHub-Nickname](https://github.com/GitHub-Nickname) | [<img src="./embed/profile/nse-5354155414388309291-1000000474_1719950399348.png" height=150 width=150> <br/> @oomia](https://github.com/oomia) | |
| 36 | + |
| 37 | +<br> |
| 38 | + |
| 39 | +## 1. Environments |
| 40 | + |
| 41 | +- |
| 42 | +- 버전 및 이슈관리 : Github, Github Issues, Github Project |
| 43 | +- 협업 툴 : Discord, GitHub Project |
| 44 | +- 서비스 배포 환경 : GitHub Pages (또는 AWS EC2) |
| 45 | +- |
| 46 | + |
| 47 | + <br> |
| 48 | + |
| 49 | +## 2. 채택한 개발 기술과 브랜치 전략 |
| 50 | + |
| 51 | +### Quartz |
| 52 | + |
| 53 | +아직 자세히 보지는 않았고, Obsidian deploy처럼 GitHub Pages로 정적 사이트 생성 지원한다고 해서 조사 중 |
| 54 | +(만약 잘 안 되면, 우선 Obsidian 내장 기능 사용하고, 방법 찾아서 변경 예정) |
| 55 | + |
| 56 | +### 브랜치 전략 |
| 57 | + |
| 58 | +- `develop` 브랜치에서부터 본인 닉네임으로 브랜치 생성 (e.g. `@ooMia`) |
| 59 | + |
| 60 | + |
| 61 | +<br> |
| 62 | + |
| 63 | +## 3. 프로젝트 구조 |
| 64 | + |
| 65 | +- Windows CMD에서 `tree /F | clip` 명령어 사용 |
| 66 | + |
| 67 | +``` |
| 68 | +│ .gitignore |
| 69 | +│ LICENSE |
| 70 | +│ README.md |
| 71 | +│ |
| 72 | +├─concepts |
| 73 | +│ │ *.md |
| 74 | +│ │ |
| 75 | +│ ├─Blockchain |
| 76 | +│ │ Archive Node.md |
| 77 | +│ │ Bitcoin.md |
| 78 | +│ │ Block.md |
| 79 | +│ │ Blockchain.md |
| 80 | +│ │ Ethereum.md |
| 81 | +│ │ Mainnet.md |
| 82 | +│ │ Merkle tree.md |
| 83 | +│ │ Node.md |
| 84 | +│ │ Smart Contract.md |
| 85 | +│ │ Testnet.md |
| 86 | +│ │ Timestamp.md |
| 87 | +│ │ |
| 88 | +│ ├─Consensus |
| 89 | +│ │ Blockchain Trilemma.md |
| 90 | +│ │ Consensus.md |
| 91 | +│ │ Mempool.md |
| 92 | +│ │ Mining.md |
| 93 | +│ │ Nonce.md |
| 94 | +│ │ PoS.md |
| 95 | +│ │ PoW.md |
| 96 | +│ │ Staking.md |
| 97 | +│ │ |
| 98 | +│ ├─Cryptocurrency |
| 99 | +│ │ Cryptocurrency.md |
| 100 | +│ │ |
| 101 | +│ ├─Cryptography |
| 102 | +│ │ Cryptography.md |
| 103 | +│ │ Zero Knowledge Proof.md |
| 104 | +│ │ |
| 105 | +│ ├─DeFi |
| 106 | +│ │ AMM.md |
| 107 | +│ │ DeFi.md |
| 108 | +│ │ |
| 109 | +│ ├─Ethereum |
| 110 | +│ ├─Finance |
| 111 | +│ │ Finance.md |
| 112 | +│ │ |
| 113 | +│ ├─Layer2 |
| 114 | +│ │ Bridge.md |
| 115 | +│ │ Layer1.md |
| 116 | +│ │ Layer2.md |
| 117 | +│ │ Optimism.md |
| 118 | +│ │ Rollup.md |
| 119 | +│ │ |
| 120 | +│ ├─Misc |
| 121 | +│ │ Mixer.md |
| 122 | +│ │ Security Audit.md |
| 123 | +│ │ Tornado.Cash.md |
| 124 | +│ │ Web3.md |
| 125 | +│ │ |
| 126 | +│ └─Regulation |
| 127 | +│ Regulation.md |
| 128 | +│ |
| 129 | +└─embed |
| 130 | + │ .gitignore |
| 131 | + │ |
| 132 | + └─img |
| 133 | +``` |
| 134 | + |
| 135 | +<br> |
| 136 | + |
| 137 | +## 4. 역할 분담 |
| 138 | + |
| 139 | +- 주제별 또는 담당 개념별로 적으면 될 듯 |
| 140 | + |
| 141 | +### 🍊이름 |
| 142 | + |
| 143 | +- **파트** |
| 144 | + - 내용 |
| 145 | + <br> |
| 146 | + |
| 147 | +## 5. 개발 기간 및 작업 관리 |
| 148 | + |
| 149 | +### 개발 기간 |
| 150 | + |
| 151 | +- 한 주는 전체적으로 점검하고 마무리해야 하고, 프로젝트 기간 시작 전까지는 모든게 끝나야 하므로 실질적인 작업은 9월 전에 종료 |
| 152 | + |
| 153 | +- 전체 개발 기간 : |
| 154 | + |
| 155 | +<br> |
| 156 | + |
| 157 | +### 작업 관리 |
| 158 | + |
| 159 | +- CONTENT |
| 160 | + <br> |
| 161 | + |
| 162 | +## 6. 신경 쓴 부분 |
| 163 | + |
| 164 | +- 링크 |
| 165 | + |
| 166 | +<br> |
| 167 | + |
| 168 | +## 7. 페이지별 기능 |
| 169 | + |
| 170 | +### [초기화면] |
| 171 | + |
| 172 | +- DESCRITPION : README 초기화면입니다. |
| 173 | + |
| 174 | +| 초기화면 (예시) | |
| 175 | +| ------------------------------------ | |
| 176 | +|  | |
| 177 | + |
| 178 | +<br> |
| 179 | + |
| 180 | +<br> |
| 181 | + |
| 182 | +## 8. 트러블 슈팅 |
| 183 | + |
| 184 | +- 링크 |
| 185 | + |
| 186 | +<br> |
| 187 | + |
| 188 | +## 9. 개선 목표 |
| 189 | + |
| 190 | +- 문제 -> 할 일 -> 결과 |
| 191 | + |
| 192 | +<br> |
| 193 | + |
| 194 | +## 10. 프로젝트 후기 |
| 195 | + |
| 196 | +### 🍊 이름 |
| 197 | + |
| 198 | +- 후기 |
0 commit comments