docs: added complete local setup guide for Dijkstra Web#7
docs: added complete local setup guide for Dijkstra Web#7KRYSTALM7 wants to merge 2 commits intoDijkstra-Edu:masterfrom
Conversation
|
@KRYSTALM7 is attempting to deploy a commit to the jrs296's projects Team on Vercel. A member of the Team first needs to authorize it. |
| ## Overview | ||
|
|
||
| Dijkstra Web is built with: | ||
| - **Next.js 15** - React framework | ||
| - **TypeScript** - Type-safe JavaScript | ||
| - **Tailwind CSS** - Utility-first styling | ||
| - **shadcn/ui** - UI component library | ||
| - **NextAuth.js** - Authentication | ||
| - **Prisma + PostgreSQL** - Database | ||
|
|
There was a problem hiding this comment.
Can we comment out the recreation doc? This needs a lot more time and effot before we go live with it
| ### Step 1: Create Next.js Project | ||
|
|
||
| ```bash | ||
| npx create-next-app@latest dijkstra-web --typescript --tailwind --app --import-alias="@/*" | ||
| cd dijkstra-web | ||
| ``` | ||
|
|
||
| When prompted, select: | ||
| - ✅ TypeScript | ||
| - ✅ ESLint | ||
| - ✅ Tailwind CSS | ||
| - ✅ App Router | ||
| - ✅ Import alias (@/*) | ||
|
|
||
| ### Step 2: Install Required Dependencies | ||
|
|
||
| ```bash | ||
| # Authentication and Database | ||
| npm install next-auth@latest @prisma/client @auth/prisma-adapter | ||
|
|
||
| # UI Components | ||
| npm install lucide-react class-variance-authority clsx tailwind-merge | ||
| npm install @radix-ui/react-dialog @radix-ui/react-dropdown-menu @radix-ui/react-slot | ||
|
|
||
| # Forms and Validation | ||
| npm install react-hook-form zod @hookform/resolvers | ||
|
|
||
| # Development Dependencies | ||
| npm install -D prisma @types/node | ||
| ``` | ||
|
|
||
| ### Step 3: Setup shadcn/ui | ||
|
|
||
| ```bash | ||
| # Initialize shadcn/ui |
| ### Step 4: Setup Database | ||
|
|
||
| ```bash | ||
| # Initialize Prisma | ||
| npx prisma init | ||
|
|
||
| # This creates: | ||
| # - prisma/schema.prisma | ||
| # - .env file | ||
| ``` | ||
|
|
||
| Update `DATABASE_URL` in `.env` file with your PostgreSQL connection string. | ||
|
|
||
| ### Step 5: Configure Prisma Schema | ||
|
|
||
| Open `prisma/schema.prisma` and replace with the complete schema for users, accounts, sessions, and verification tokens (refer to NextAuth.js Prisma adapter documentation for the schema). |
There was a problem hiding this comment.
When did we start using Prisma now
|
|
||
| Open `prisma/schema.prisma` and replace with the complete schema for users, accounts, sessions, and verification tokens (refer to NextAuth.js Prisma adapter documentation for the schema). | ||
|
|
||
| ### Step 6: Run Database Migrations |
There was a problem hiding this comment.
And when did we start doing this via Prisma
|
I will redo it don't worry. |
|
|
||
| ### Run Migrations | ||
|
|
||
| ```bash | ||
| # Generate Prisma Client | ||
| npx prisma generate | ||
|
|
||
| # Run database migrations | ||
| npx prisma migrate dev | ||
|
|
||
| # Seed the database (if seed file exists) | ||
| npx prisma db seed | ||
| ``` |
There was a problem hiding this comment.
Completely removed the Migrations section
|
|
||
| --- | ||
|
|
||
| *Happy coding! 🚀* No newline at end of file |
There was a problem hiding this comment.
Removed the mentioned line.
|
|
||
| You should see the Dijkstra Web platform homepage. | ||
|
|
||
| ## Available Routes |
There was a problem hiding this comment.
This needs to be an introduction to the Dijkstra Web Project, not an introduction to Dijkstra
There was a problem hiding this comment.
Let's remove this file from this PR. it requires a lot more work before it is ready
JRS296
left a comment
There was a problem hiding this comment.
Remove How to recreate
Make the changes for how to run locally
Tests seem fine, but will be changed in the future
Introduction - Needs to be an introduction to Dijkstra Web, not DIjkstra as a whole
Overall feels q bit sloppy, a lot of AI use observed. Can be better
|
Fine da No problem. |
This PR adds a complete, self-contained How to Run Locally guide for the Dijkstra Web project.
Changes Made
how-to-run-locally.md,'Introduction.md','how-to-test.md','how-to-recrete.md'.Issue Reference
Closes #4