Skip to content

Fix/documentation md #2178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Naveen-Boddepalli wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −12
Open

Fix/documentation md #2178

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Everything you need to run DevTrack locally from scratch in under 10 minutes.

| Tool | Version | Check |
|------|---------|-------|
| Node.js | >= 18 | `node -v` |
| npm | >= 9 | `npm -v` |
| Node.js | >= 20 | `node -v` |
| pnpm | >= 9 | `pnpm -v` |
| Git | any | `git --version` |

You also need free accounts on:
Expand All @@ -24,7 +24,7 @@ You also need free accounts on:
```bash
git clone https://github.com/Priyanshu-byte-coder/devtrack.git
cd devtrack
npm install
pnpm install
```

---
Expand Down Expand Up @@ -110,7 +110,7 @@ openssl rand -base64 32
## 5. Run the dev server

```bash
npm run dev
pnpm dev
```

Open [http://localhost:3000](http://localhost:3000). Click **Sign in with GitHub**.
Expand Down Expand Up @@ -236,14 +236,14 @@ All GitHub API calls use the signed-in user's OAuth token — stored in the sess

| Command | What it does |
|---------|-------------|
| `npm run dev` | Start dev server at localhost:3000 |
| `npm run build` | Production build |
| `npm run lint` | ESLint |
| `npm run type-check` | TypeScript compiler check (no emit) |
| `pnpm dev` | Start dev server at localhost:3000 |
| `pnpm build` | Production build |
| `pnpm lint` | ESLint |
| `pnpm type-check` | TypeScript compiler check (no emit) |

Run lint and type-check before pushing:
```bash
npm run lint && npm run type-check
pnpm lint && pnpm type-check
```

---
Expand Down Expand Up @@ -346,12 +346,12 @@ On Windows PowerShell:
Next.js reads `.env.local` only at startup. After any change, stop and restart:

```bash
npm run dev
pnpm dev
```

#### 5. Check the server console for the real error

The browser only shows `error=github` — the actual error is printed to the **terminal running `npm run dev`**. Look for lines starting with `[next-auth]` or `signIn:`.
The browser only shows `error=github` — the actual error is printed to the **terminal running `pnpm dev`**. Look for lines starting with `[next-auth]` or `signIn:`.

---

Expand Down Expand Up @@ -395,4 +395,4 @@ Open a [GitHub Discussion](https://github.com/Priyanshu-byte-coder/devtrack/disc


### Husky Hooks Troubleshooting Guide
- If prettier-check fails in sandboxed environments, run git commit with --no-verify.
- If prettier-check fails in sandboxed environments, run git commit with --no-verify.