Skip to content

docs: added complete local setup guide for Dijkstra Web#7

Open
KRYSTALM7 wants to merge 2 commits intoDijkstra-Edu:masterfrom
KRYSTALM7:Sujan_DijkstraWeb_Docs
Open

docs: added complete local setup guide for Dijkstra Web#7
KRYSTALM7 wants to merge 2 commits intoDijkstra-Edu:masterfrom
KRYSTALM7:Sujan_DijkstraWeb_Docs

Conversation

@KRYSTALM7
Copy link
Member

This PR adds a complete, self-contained How to Run Locally guide for the Dijkstra Web project.

Changes Made

  • Added a fully rewritten how-to-run-locally.md,'Introduction.md','how-to-test.md','how-to-recrete.md'.
  • Ensured all internal links are relative and valid
  • Simplified setup steps for beginners

Issue Reference

Closes #4

@vercel
Copy link

vercel bot commented Jan 18, 2026

@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.

Comment on lines +7 to +16
## 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

Copy link
Member

@JRS296 JRS296 Jan 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we comment out the recreation doc? This needs a lot more time and effot before we go live with it

Comment on lines +29 to +63
### 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
Copy link
Member

@JRS296 JRS296 Jan 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is very generic

Comment on lines +72 to +87
### 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).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

@JRS296 JRS296 Jan 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And when did we start doing this via Prisma

@KRYSTALM7
Copy link
Member Author

I will redo it don't worry.
It was not chatgpt btw.
I did write a better one had formating issues after which it is messed up.

Comment on lines +168 to +180

### 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
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't use Prisma

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Completely removed the Migrations section


---

*Happy coding! 🚀* No newline at end of file
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the mentioned line.


You should see the Dijkstra Web platform homepage.

## Available Routes
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed 👍

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be an introduction to the Dijkstra Web Project, not an introduction to Dijkstra

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noted will change it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's remove this file from this PR. it requires a lot more work before it is ready

Copy link
Member

@JRS296 JRS296 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@KRYSTALM7
Copy link
Member Author

Fine da No problem.
I also kida felt i gave you a bad one while raising it .

@KRYSTALM7 KRYSTALM7 changed the title docs: add complete local setup guide for Dijkstra Web docs: added complete local setup guide for Dijkstra Web Jan 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation for Dijkstra Web

2 participants