Skip to content

Commit 233867d

Browse files
committed
docs: added notes for TypeScript, fixed some typos
1 parent 68af0cd commit 233867d

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

docs/development.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ The default CSS theme is located in the **assets/templates/default** directory a
111111
You can create your own CSS theme by copying the default theme and modifying it to suit your needs.
112112
The CSS theme is based on Bootstrap’s CSS custom properties for fast and forward-looking design and development.
113113
We support a light and a dark mode in our default theme.
114-
For more information check out the documentation on [Bootstrap](https://getbootstrap.com/docs/5.3/customize/css-variables/).
114+
For more information, check out the documentation on [Bootstrap](https://getbootstrap.com/docs/5.3/customize/css-variables/).
115115

116116
## 6.4 Custom CSS
117117

@@ -138,7 +138,7 @@ However, there are a few rules and limitations when doing so and this page lists
138138
2. Copyright notices will be changed to phpMyFAQ Team. But contributors will get credit for their work!
139139
3. All third party code will be reviewed, tested and possible modified before being released.
140140

141-
These basic rules makes it possible for us to earn a living of the phpMyFAQ project, but it also ensures that the code
141+
These basic rules make it possible for us to earn a living of the phpMyFAQ project, but it also ensures that the code
142142
remains Open Source and under the MPL 2.0 license.
143143
All contributions will be added to the changelog and on the phpMyFAQ website.
144144

@@ -152,10 +152,11 @@ work on your copy and send pull requests.
152152
Before working on phpMyFAQ, set up a local environment with the following software:
153153

154154
- Git
155-
- PHP 8.2+
156-
- PHPUnit 10.x
155+
- PHP v8.2+
156+
- PHPUnit v11.x
157157
- Composer
158-
- Node.js v20+
158+
- Node.js v22+
159+
- TypeScript v5.x
159160
- PNPM
160161
- Docker
161162

@@ -185,13 +186,13 @@ Every PR on GitHub will check the coding standards and tests as well.
185186

186187
The Dockerfile provided in the phpMyFAQ repository only builds an environment
187188
to run any release for development purpose.
188-
It does not contain any code as the phpmyfaq folder is meant to be mount as the /var/www/html folder in the container.
189+
It does not contain any code as the phpmyfaq folder is meant to be mounted as the /var/www/html folder in the container.
189190

190191
For development purposes, you can start a full stack to run your current phpMyFAQ source code from your local repository.
191192

192193
$ docker-compose up
193194

194-
The command above starts 9 containers for multi database development as following.
195+
The command above starts nine containers for multi database development as following.
195196

196197
_Specific images started once to prepare the project:_
197198

@@ -217,7 +218,7 @@ Then services will be available at the following addresses:
217218
- phpMyAdmin: (http://localhost:8000)
218219
- pgAdmin: (http://localhost:8008)
219220

220-
### 6.5.6 Fetch 3rd party libraries and install phpMyFAQ
221+
### 6.5.6 Fetch third party libraries and install phpMyFAQ
221222

222223
After cloning your forked repository, you have to fetch the 3rd party libraries used in phpMyFAQ:
223224

@@ -227,16 +228,20 @@ After cloning your forked repository, you have to fetch the 3rd party libraries
227228
$ pnpm install
228229
$ pnpm build
229230

230-
Then just start a normal, local phpMyFAQ installation.
231+
Then start a normal, local phpMyFAQ installation.
231232

232-
If you change some JavaScript code, you have to re-build the .js files into one with the following PNPM task:
233+
If you change some TypeScript code, you have to re-build the .ts files into one with the following PNPM task:
233234

234235
$ pnpm build
235236

236237
During development, you can use the watch mode:
237238

238239
$ pnpm build:watch
239240

241+
For a production build, you can use the following command:
242+
243+
$ pnpm build:prod
244+
240245
To run the PHPUnit-based tests, you can use the following command:
241246

242247
$ composer test

0 commit comments

Comments
 (0)