fix command, info in readme

This commit is contained in:
austinkelsay 2025-04-02 17:46:58 -05:00
parent 2745382283
commit 3ab276ea40
No known key found for this signature in database
GPG Key ID: 5A763922E5BA08EE
3 changed files with 10 additions and 7 deletions

View File

@ -1,7 +0,0 @@
module.exports = {
extends: 'next/core-web-vitals',
rules: {
// Turn off exhaustive-deps rule that's causing most of the warnings
'react-hooks/exhaustive-deps': 'off'
}
}

View File

@ -119,6 +119,14 @@ PlebDevs is an open-source platform that combines educational content, community
Now the database is running and the migrations are applied.
You can now run locally.
### Linting and Code Formatting
We use ESLint with Next.js configuration and Prettier for code formatting. We've kept the linting process simple with just two commands:
- `npm run lint` - Run ESLint to check for issues
- `npm run lint:fix` - Fix both ESLint and Prettier formatting issues in one command
Before submitting a PR, please run `npm run lint:fix` to ensure your code follows our standards.
## Contributing

View File

@ -7,6 +7,7 @@
"build": "npx prisma generate && next build && npx prisma migrate deploy",
"start": "next start",
"lint": "next lint",
"lint:fix": "next lint --fix && prettier --write \"**/*.{js,jsx,ts,tsx,json,md}\"",
"postinstall": "npx prisma generate"
},
"dependencies": {
@ -58,6 +59,7 @@
"eslint": "^8",
"eslint-config-next": "14.2.5",
"postcss": "^8",
"prettier": "^3.2.5",
"tailwindcss": "^3.4.1"
}
}