codu

科德

編碼器的空間

Codú是Web開發人員的最終社區，可以學習，分享和為您的項目提供支持。這是提高技能並建立投資組合的理想場所。在Codú，我們都在這裡互相幫助，成為Web開發人員。另外，Codú使您更容易為您的下一個大型項目找到合作者。

---

加入對話

我們在不和諧方面有一個很棒的社區。單擊此處加入！

---

安裝

1. 分叉項目
2. 用git clone https://github.com/YOUR_USERNAME/codu.git克隆。
3. 導航到項目目錄cd codu 。
4. 安裝依賴項：

npm install

• 如果您在安裝依賴項上有任何問題，請根據.nvmrc中定義的節點版本檢查您的節點版本。如果您使用的是nvm ，則可以在安裝依賴項之前運行nvm use 。

5. 創建一個.env文件並添加以下變量。您可以使用cat sample.env > .env複製sample.env的內容。

 # This default value is if you run our local docker-compose.yml file to create the database.
DATABASE_URL=postgresql://postgres:[email protected]:5432/postgres
# Setup your GitHub ID & Secret on GitHub: https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps
# For development, make sure you set up this with a Homepage URL of http://localhost:3000/ and an Authorization callback URL of http://localhost:3000/api/auth
GITHUB_ID=YOUR_GITHUB_APP_ID
GITHUB_SECRET=YOUR_GITHUB_APP_SECRET
NEXTAUTH_URL=http://localhost:3000/api/auth

有關設置它們的更詳細指南，請訪問“環境變量”部分。

注意：在繼續之前，請確保您的數據庫正在運行。

6. 通過運行毛毛雨設置數據庫中的表：

npm run db:migrate

完整命令可以在我們的poffage.json文件中看到。

7. 通過運行來為數據庫播種數據庫：

npm run db:seed

完整命令可以在我們的poffage.json文件中看到。

8. 最後，運行開發服務器：

npm run dev

完成上述命令後，導航到http：// localhost：3000在瀏覽器中查看結果。

您可以通過修改pages/index.tsx開始旅程。使用自動更新功能，您編輯文件時更新頁面。

pages/api目錄映射到/api/* 。該目錄中的文件被視為API路由而不是React頁面。

在此處了解有關API路線的更多信息。

環境變量

Database_url

DATABASE_URL是與PostgreSQL數據庫（版本15.0）的連接字符串。

默認情況下，我們指出一個數據庫與docker-compose.yml文件中的Docker本地運行。

要運行此文件，請確保已安裝了Docker，並且Docker正在運行。

運行命令docker compose up 。

另外，如果您在本地運行PostgreSQL，則可以使用本地連接字符串或從Supabase等免費服務中獲取一個字符串。

github_id和github_secret

目前，我們僅允許通過GitHub進行身份驗證。為了實現這一點，您需要具有一個GITHUB_ID和GITHUB_SECRET值。

在GitHub上設置您的GitHub ID和Secret：

• 單擊此處設置一個新的OAuth應用程序，並填寫如下所示的詳細信息。

為了開發，請確保您使用的主頁URL設置

 http://localhost:3000/

和授權回調URL

 http://localhost:3000/api/auth

單擊“註冊應用程序”按鈕後，您應該看到GITHUB_ID並能夠生成新的客戶端秘密。生成秘密後，請確保將此值複製到.env文件，因為一旦刷新頁面，就無法再次看到此值。

有關在此處的GitHub文檔中授權OAuth的更多信息。

本地設置無密碼auth

為了在本地使用無密碼登錄，您需要具有ACCESS_KEY和SECRET_KEY值。

在此處查看示例.env文件，以查看如何填充這些值。

注意：目前，SNS服務的AWS區域是“ EU-West-1”的硬編碼；如果您的SNS服務位於其他區域，則可能有必要更改此操作。

nextauth_url

您不需要在此處更改默認值。這是下一個Auth用作您網站的身份驗證URL的變量。

 NEXTAUTH_URL=http://localhost:3000/api/auth

示例.env文件可以在此處找到。您可以將其重命名為.env以開始。

？‍貢獻指南

• 貢獻非常感謝。貢獻使開源社區成為學習，啟發和創造的絕佳場所。
• 查看我們為回購貢獻的貢獻指南。它包括
  • 如何貢獻
  • 如何創建拉力請求
  • 運行測試
  • 提交消息的樣式指南

？貢獻的先決條件

• git

？文檔貢獻

• 降價

？代碼貢獻

• 反應
• next.js
• Postgresql
• 尾風
• 細雨

其他資源

要了解有關Next.js的更多信息，請查看以下資源：

• Next.js文檔 - 了解Next.js功能和API。
• 學習Next.js-互動Next.js教程。

編輯文檔

要了解編輯器快捷鍵和Hotkeys，您可以查看此文檔：

• MarkDoc編輯熱鍵和快捷方式

？ E2E測試

有關E2E測試的信息，請在此處參考我們的專用文檔。

？問題

歡迎您開放問題，討論有關改善Codú的想法。鼓勵和讚賞增強功能。