Skip to content

Commit 703f61e

Browse files
committed
Added comments to Readme.md
1 parent 03d2511 commit 703f61e

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Django + Nextjs Template: Standardised CFC Tech Stack
88

99
- **Node.js 18+** and **npm** - [Download here](https://nodejs.org/)
1010
- **uv 0.8+** (Python package manager) - [Installation guide](https://docs.astral.sh/uv/getting-started/installation/)
11+
-- **Next.js** use this command in bash npm install -g next
1112

1213
### Installation Steps
1314

@@ -111,24 +112,30 @@ python manage.py test
111112
```bash
112113
cd client
113114

115+
### Start development server ###
114116
# Development server
115117
npm run dev
116118

119+
### Start production server ###
117120
# Build for production
118121
npm run build
119122

120123
# Start production server
121124
npm start
122125

126+
### Checks for code problems ###
123127
# Run linting
124128
npm run lint
125129

130+
### Fix found code problems ###
126131
# Fix linting issues
127132
npm run lint:fix
128133

134+
### Checks for typescript issues ###
129135
# Type checking
130136
npm run typecheck
131137

138+
### Formats code, Technically its the Prettier extension ###
132139
# Format code
133140
npm run format
134141
```

0 commit comments

Comments
 (0)