Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add "first steps" page and reduce h3 spacing #703

Merged
merged 17 commits into from
Nov 8, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Prev Previous commit
Next Next commit
add "first steps" page to docs
  • Loading branch information
c-ehrlich committed Nov 7, 2022
commit 7a9e88442b03a302589f84f280553f2597d6eaa4
1 change: 1 addition & 0 deletions www/src/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ export const SIDEBAR: Sidebar = {
{ text: "Other Recommendations", link: "en/other-recs" },
],
Usage: [
{ text: "First Steps", link: "en/usage/first-steps" },
{ text: "Next.js", link: "en/usage/next-js" },
{ text: "TypeScript", link: "en/usage/typescript" },
{ text: "tRPC", link: "en/usage/trpc" },
Expand Down
31 changes: 31 additions & 0 deletions www/src/pages/en/usage/first-steps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: First Steps
description: Getting started with your new T3 App
layout: ../../../layouts/docs.astro
---

You just scaffolded a new T3 App and are ready to go. Here is the bare minimum to get your app working.

## Database

If your app includes Prisma, make sure to run `npx prisma db push` from the root directory of your app. Note that you need to restart the dev server after doing this.
c-ehrlich marked this conversation as resolved.
Show resolved Hide resolved

## Authentication

If your app includes Next-Auth, we get you started with the `DiscordProvider`. This is one of the simplest providers that Next-Auth offers, but it still requires a bit of initial setup on your part.
c-ehrlich marked this conversation as resolved.
Show resolved Hide resolved

Of course if you prefer to use a different auth provider, you can also use one of the [many providers](https://next-auth.js.org/providers/) that Next-Auth offers.
c-ehrlich marked this conversation as resolved.
Show resolved Hide resolved

1. You will need a Discord account, so register one if you haven't already.
2. Navigate to https://discord.com/developers/applications and click "New Application" in the top right corner. Give your application a name and agree to the Terms of Service.
3. Once your application has been created, navigate to "Settings → OAuth2 → General".
4. Copy the "Client ID" and add it to your `.env` as `DISCORD_CLIENT_ID`.
5. Click "Reset Secret", copy the new secret, and add it to your `.env` as `DISCORD_CLIENT_SECRET`.
6. Click "Add Redirect" and type in `http:https://localhost:3000/api/auth/callback/discord`.
nexxeln marked this conversation as resolved.
Show resolved Hide resolved
7. Save Changes. You should now be able to log in. Note that you need to restart the dev server for changes in environment variables to be reflected in your app.
juliusmarminge marked this conversation as resolved.
Show resolved Hide resolved

## Next Steps

* If your app includes tRPC, check out `src/pages/index.tsx` and `src/server/trpc/router/example.ts` to see how tRPC queries work.
* Have a look around the `create-t3-app` docs, as well as the docs of the packages that your app includes.
* Join the [Discord](https://t3.gg/discord) and give us a star on [GitHub](https://github.com/t3-oss/create-t3-app) :^)
nexxeln marked this conversation as resolved.
Show resolved Hide resolved