Dashboard ❖ Roadmap ❖ Contribute ❖ Create issue ❖ X/Twitter
Slug is a service that offers to shorten urls in a simple, fast and secure way. It's built with T3 Stack, a web development stack made by Theo focused on simplicity, modularity, and full-stack typesafety.
This project uses the following technologies:
⚠️ This is a community project, not associated with Vercel.
Requirements:
Steps:
git clone [email protected]:YOU_USER/slug.git
# Install pnpm globally if you don't have it:
npm install -g pnpm
# and install dependencies:
pnpm install
🚧 The environment variables must match the following schema.
# Database:
DATABASE_URL= # "file:./dev.db"
TURSO_DATABASE_URL=
TURSO_AUTH_TOKEN=
# Auth.js =>
AUTH_SECRET=
# Github Provider =>
GITHUB_ID=
GITHUB_CLIENT_SECRET=
# Google Provider =>
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
Database:
Auth.js:
AUTH_URL
is the URL of your Auth.js API, for example, /api/auth
. You can change it in the auth.ts
file.Github Credentials:
Google Credentials:
pnpm db:migrate
package.json
, modify the db:push
command with the name of the migration folder (2024xxxxxxxxxx_init) and run it in your terminal:pnpm db:push
pnpm dev
and open http://localhost:3000 with your browser 🚀
pnpm db:studio
and open http://localhost:5555 with your browser ✨
This is the roadmap I will be following for the complete migration to v3:
- ✅ = Stable, completed.
- 🔔 = Stable, but unexpected errors may appear.
- ⚙️ = In progress.
⬆️ Known issues:
⬆️ Dependencies:
@prisma/adapter-libsql
, @prisma/client
& prisma
to the stable version when it's released.authjs
to the stable version (v5) when it's released.⬆️ Auth:
🔔 Only for users who have not previously logged in with an existing email address in their Github account. This is an issue that will be worked on soon.
⬆️ Middleware:
/*
and /s/*
.⬆️ Dashboard (main):
⬆️ Dashboard (tags):
🔔 Add option to change tag color.
⬆️ Dashboard (settings):