Skip to content

Commit

Permalink
First draft of docs completed
Browse files Browse the repository at this point in the history
  • Loading branch information
shreyashrangrej committed Sep 21, 2023
1 parent be4ecd1 commit db3e2c7
Show file tree
Hide file tree
Showing 6 changed files with 96 additions and 0 deletions.
10 changes: 10 additions & 0 deletions www/pages/docs/Authentication/Discord.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Discord as Authentication Provider

To configure discord as authentication provider configure these environment variables in `.env`.

```.env filename=".env" copy
DISCORD_CLIENT_ID=
DISCORD_CLIENT_SECRET=
```

Click [here](https://discord.com/developers/docs/topics/oauth2) to know more about discord oauth2.
15 changes: 15 additions & 0 deletions www/pages/docs/Authentication/Email.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# GitHub as Authentication Provider

To configure Email as authentication provider configure these environment variables in `.env`.

```.env filename=".env" copy
SMTP_HOST=
SMTP_PORT=
SMTP_USER=
SMTP_PASSWORD=
SMTP_SENDER=
RESEND_API=
```

It is recommended to use Resend as SMTP provider.
Click [here](https://resend.com/docs/introduction) to know more about Resend.
10 changes: 10 additions & 0 deletions www/pages/docs/Authentication/GitHub.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# GitHub as Authentication Provider

To configure GitHub as authentication provider configure these environment variables in `.env`.

```.env filename=".env" copy
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=
```

Click [here](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps) to know more about GitHub oauth2.
10 changes: 10 additions & 0 deletions www/pages/docs/Authentication/Google.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Discord as Authentication Provider

To configure discord as authentication provider configure these environment variables in `.env`.

```.env filename=".env" copy
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
```

Click [here](https://developers.google.com/identity/protocols/oauth2) to know more about discord oauth2.
42 changes: 42 additions & 0 deletions www/pages/docs/Stack/TypeScript.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# About TypeScript

EntApex is purely built with TypeScript and packages that support TypeScript. TypeScript is JavaScript with syntax for types. TypeScript is a strongly typed programming language that builds on JavaScript, giving you better tooling at any scale.

## TypeScript Document

Click [here](https://www.typescriptlang.org/docs) to read more.

## TypeScript Config File

EntApex uses target as ESNext becuase Drizzle ORM supports it.

```json filename="tsconfig.json" copy
{
"compilerOptions": {
"target": "ESNext",
"lib": ["dom", "dom.iterable", "esnext"],
"allowJs": true,
"skipLibCheck": true,
"strict": true,
"forceConsistentCasingInFileNames": true,
"noEmit": true,
"esModuleInterop": true,
"module": "esnext",
"moduleResolution": "bundler",
"resolveJsonModule": true,
"isolatedModules": true,
"jsx": "preserve",
"incremental": true,
"plugins": [
{
"name": "next"
}
],
"paths": {
"@/*": ["./src/*"]
}
},
"include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
"exclude": ["node_modules"]
}
```
9 changes: 9 additions & 0 deletions www/pages/docs/Stack/Zod.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# About Zod

Zod is a TypeScript-first schema declaration and validation library. I'm using the term "schema" to broadly refer to any data type, from a simple string to a complex nested object.

Zod is designed to be as developer-friendly as possible. The goal is to eliminate duplicative type declarations. With Zod, you declare a validator once and Zod will automatically infer the static TypeScript type. It's easy to compose simpler types into complex data structures.

## Zod Documentation

Click [here](https://zod.dev/?id=table-of-contents) to read more.

1 comment on commit db3e2c7

@vercel
Copy link

@vercel vercel bot commented on db3e2c7 Sep 21, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.