Skip to content

pheralb/slug

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

πŸš€ Short link Β Β β€’Β Β  οΏ½? Contribute Β Β β€’Β Β  οΏ½?οΏ½ Twitter

GitHub stars GitHub issues GitHub license Required Node.JS >=16.0.0

πŸ€” What is T3 Stack?

The T3 Stack is a web development stack made by Theo focused on simplicity, modularity, and full-stack typesafety. This project is using:

πŸ“¦ Project structure

- prisma
- public
- src
  |- components
  |- env
  |- layout
  |- motions
  |- pages
  |- schema
  |- server
  |- styles
  |- types
  |- ui
  |- utils

πŸ‘¨οΏ½?πŸš€ Getting Started

🚧 You will need Nodejs +16 (LTS recommended) installed.

  1. Fork this project:
  1. Clone the repository:
git clone git@github.com:YOU_USER/slug.git
  1. Install dependencies:
npm install
# or
pnpm install
# or
yarn install
# or
ultra install
  1. Create a .env file with the following content:

🚧 The environment variables must match the following schema.

# Planetscale DB URL:
DATABASE_URL:

# Github OAuth secrets:
GITHUB_ID:
GITHUB_CLIENT_SECRET:

# Next Auth config:
NEXTAUTH_SECRET:
NEXTAUTH_URL:

πŸ”‘ How to get environment variables:

Planetscale database:

🚧 The environment variable in the dev branch is not the same as main. When you deploy your app to production, in the environment variables change DATABASE_URL to the main variable.

Github OAuth:

Next Auth:

  • NEXTAUTH_SECRET: mykey123 for example.
  • NEXTAUTH_URL: http://localhost:3000/.
  1. Ready πŸ₯³, now run:
# Push your DB to Planetscale:
npx prisma db push

# Run the project:
npm run dev

# (Optional) Run Prisma Studio to see your DB data:
npx prisma studio

😊 Contributing:

πŸŽ‰ Deploy on Vercel

πŸ”‘ License