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ú的想法。鼓励和赞赏增强功能。