Skip to content

🌱 A URL shortener built with Create JD App: Solid Start + Tailwind CSS + Typescript + tRPC + Authjs & Prisma.

License

Notifications You must be signed in to change notification settings

Jcanotorr06/linkr

Repository files navigation

Banner

πŸš€ Short Link Β Β β€’Β Β  🀝 Contribute Β Β β€’Β Β  πŸ€– Github

GitHub stars GitHub issues GitHub license

πŸ€” What is Create JD App?

Create JD App is the quickest and most efficient way to start a new fullstack Solid web app, inspired by the T3 Stack, which 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
  |- routes
  |- schema
  |- server
  |- styles
  |- 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:

# Auth.js config:
AUTH_SECRET
AUTH_URL
AUTH_TRUST_HOST=true

πŸ”‘ 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:

  • AUTH_SECRET: mykey123 for example.
  • AUTH_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

About

🌱 A URL shortener built with Create JD App: Solid Start + Tailwind CSS + Typescript + tRPC + Authjs & Prisma.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks