nextjs starter

NextJS启动器

一个next.js入门套件模板，带有17 +打字稿 +尾风CSS 2 + react Query 3 + NextAuth.js（带有GitHub auth + auth +无密码auth） + Fauna DB

演示

• 网站
• 博客文章（旧）
  • 即将替换为新的博客文章。

本地运行

• 克隆项目

    git clone https://github.com/pbteja1998/nextjs-starter.git

• 转到项目目录

    cd nextjs-starter

• 安装依赖项

    yarn

• 根据说明创建.env.Local和更改ENV变量。

    cp .env.example .env.local

• 提示时，通过运行以下命令并粘贴Fauna Secret密钥来设置数据库。有关Fauna-Schema移民的更多详细信息。

    yarn setup-db

• 启动服务器

    yarn dev

环境变量

要运行此项目，您需要将以下环境变量添加到.env.local文件中

• NEXTAUTH_URL
  • 这是您的应用程序URL。在本地，您可以将其设置为http://localhost:3000
• SECRET
  • 将其设置为任何随机生成的字符串
• EMAIL_SERVER
  • 这是电子邮件服务器字符串。它的格式是smtp://username:[email protected]:587 。用自己的凭据替换username ， password和smtp.example.com 。
• EMAIL_FROM
  • 您发送电子邮件的电子邮件地址。
• GITHUB_ID
• GITHUB_SECRET
  • 您需要创建一个github oauth应用程序，并从该应用程序中获取github_id和github_secret。
  • 您可以按照以下说明进行操作。
  • 在创建用于本地开发的OAuth应用程序时，您可以将Homepage URL设置为http://localhost:3000 ： Authorization Callback URL http://localhost:3000/api/auth/callback/github
• LINKEDIN_ID
• LINKEDIN_SECRET
  • 您需要为LinkedIn创建一个OAuth应用程序。您可以将回调URL设置为http://localhost:3000/api/auth/callback/linkedin
• FAUNADB_SECRET
  • 创建一个新的Fauna服务器密钥并将该变量设置为该密钥

常问问题

如何在本地运行动物区系？

请注意，这是完全可选的。您可以在Fauna Cloud中直接创建数据库，并直接使用您在此处生成的秘密。

我们正在使用Fauna Dev Docker容器在本地运行Fauna实例。

这些是本地设置动物群容器的说明。

 # Pull the latest Docker container:
docker pull fauna/faunadb:latest

# Verify that the container executes correctly:
docker run fauna/faunadb --help

安装此功能后，您可以使用以下命令启动容器

docker run --rm --name faunadb -p 8443:8443 -p 8084:8084 fauna/faunadb

请注意，每次运行它时，这都会创建一个新的Fauna实例，当您停止此容器时，所有数据都将被清除。对于其他配置选项和方法，请浏览文档。

您需要在模板中进行的更改：

• 您必须在.env.local文件中设置USE_FAUNA_DOCKER=true
• 每次启动Docker容器时，都需要首先应用迁移。您可以通过运行yarn setup-docker-db来做到这一点。
• 有关Fauna-Schema-Origrate和Fauna Dev的更多详细信息。

反馈和支持

如有反馈和支持，请在此存储库中打开一个问题。

执照

麻省理工学院

路线图

TBD

贡献

TBD

部署

动词

TBD

Netlify

TBD