Flip Astrocards Over!

以卡牌遊戲的方式吸引群眾為天文相關的開源Python套件建檔的平台(Django專案)。

專案開發共筆

• HackMD文件

給協作者的專案開發須知

開發環境建立

本專案以Python 3.6, Django 1.11和PostgreSQL開發，並以Git/GitHub控制程式碼版本，請協作者依照以下步驟建立開發環境:

• 安裝Python 3.6版的Miniconda

• 安裝版本控制工具Git (Linux; Windows; Mac OSX)，並設定使用者的Email及名稱

• 安裝PostgreSQL資料庫 (步驟說明待補)

• 用conda create建立此專案的開發環境

  # 創建名為astrocardsEnv的虛擬環境並預先在該環境中安裝Django
  conda create -n astrocardsEnv python=3.6
  # 啟用並進入虛擬環境astrocardsEnv
  source activate astrocardsEnv

• 從《Flip Astrocards Over》的GitHub repository 以git clone指令複製一份專案原始碼到自己的電腦中，並以pip install指令安裝所需Python套件

  git clone https://github.com/Astrohackers-TW/flip-astrocards-over.git
  cd flip-astrocards-over
  pip install -r requirements/local.txt

• 啟動開發伺服器

  # 輸入完以下指令後，在瀏覽器輸入 http://127.0.0.1:8000 或是 http://localhost:8000 即可在local端瀏覽此Django專案所建立的網頁
  python manage.py runserver

flip-astrocards-over專案的目錄結構概要

為了讓專案更為結構化且符合實務， 此專案的目錄結構採用Django專案範本產生器Cookiecutter Django及Two Scoops of Django 1.11一書所偏好的project layout， 而非Django project預設的目錄結構。 flip-astrocards-over專案根目錄包含以下子目錄及檔案:

• config/目錄: 包含settings/目錄、URL設定檔及WSGI設定檔。 settings/目錄中又包含用以進行local端開發 (local.py) 、測試(test.py)及上線(production.py)等不同狀況時的設定檔, 這三個檔都繼承自基本設定檔base.py。

• astrocards/目錄: 將包含此專案中司職不同功能的apps及其所屬的templates和static files。

• requirements/目錄: 包含用以進行local端開發 (local.txt) 、測試(test.txt)及上線(production.txt)等不同狀況時的Python套件需求, 這三個檔都繼承自基本套件需求檔base.txt。

• docs/目錄: 將包含專案相關的文件檔案。

• README.md: 此專案GitHub repository的主說明文件。

• .gitignore: 包含git commit時不需要版本控制而要忽略的檔案列表及規則。

• LICENSE-CODE和LICENSE-TEXT: 分別為專案程式碼及文件的開源授權條款。

規範

• 程式碼風格規範:
  • PEP 8
  • Django Documentation - Coding style
• Git/GitHub規範:

  • git commit message 請用英文撰寫， 並參考如何寫一個 Git Commit Message一文

  • 《Flip Astrocards Over》GitHub repository的Issues以中文或英文撰寫皆可