Skip to content

Latest commit

 

History

History
69 lines (53 loc) · 2.87 KB

README.md

File metadata and controls

69 lines (53 loc) · 2.87 KB
Raw

Create T3 App

This is a T3 Stack project bootstrapped with create-t3-app.

What's next? How do I make an app with this?

We try to keep this project as simple as possible, so you can start with just the scaffolding we set up for you, and add additional things later when they become necessary.

If you are not familiar with the different technologies used in this project, please refer to the respective docs. If you still are in the wind, please join our Discord and ask for help.

Learn More

To learn more about the T3 Stack, take a look at the following resources:

You can check out the create-t3-app GitHub repository — your feedback and contributions are welcome!

How do I deploy this?

Follow our deployment guides for Vercel, Netlify and Docker for more information.

Local test env setup

  1. Install node modules

    npm i

  2. Copy .env.example

    cp .env.example

  3. Since social login is required to use mdbook, at least one or more OAuth clients must be created and environment variables must be set.

    • Create a new GitHub OAuth app
      • Create GitHub oauth app
      • Copy the client id and client secret to GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET in the .env file, respectively.
    • Create a new Google OAuth client
      • Setting up OAuth 2.0
      • Copy the client id and client secret to GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET in the .env file, respectively.

  4. Setup local DB

    curl --proto '=https' --tlsv1.2 -sSf https://tiup-mirrors.pingcap.com/install.sh | sh
. ~/.profile
    • Launch the local db and push the Prisma schema into it.
    tiup playground --db 1 --pd 3 --kv 3 --without-monitor
# Wait a minute for the cluster to finish starting...
npm run db:push
    • You can access TiDB database the following URL
      • DATABASE_URL="mysql://root@localhost:4000/test"
      • This environment variable is set by default in the .env file.

  5. Run app

    npm run dev