DorianNiemiecSVRJS/svrjs
Archived
1
0
Fork 0
forked from svrjs/svrjs
Code Pull requests Activity

docs: update file structure in README.md

Browse source
This commit is contained in:
Dorian Niemiec 2024-09-02 07:42:28 +02:00
parent ea8f17eb7d
commit dad4496488
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -116,6 +116,7 @@ You can read the [SVR.JS documentation](https://svrjs.org/docs/tentative) to get
## File structure ## File structure
The file structure for SVR.JS source code looks like this: The file structure for SVR.JS source code looks like this:
- .husky - Git hooks
- assets - files to copy into dist folder and to the archive - assets - files to copy into dist folder and to the archive
- dist - contains SVR.JS, assets, and SVR.JS utiltiies - dist - contains SVR.JS, assets, and SVR.JS utiltiies
- generatedAssets - assets generated by the build script - generatedAssets - assets generated by the build script
@ -131,9 +132,12 @@ The file structure for SVR.JS source code looks like this:
- middleware - tests for middleware - middleware - tests for middleware
- utils - unit tests for utility functions - utils - unit tests for utility functions
- utils - SVR.JS utilities (each utility has a single file) - utils - SVR.JS utilities (each utility has a single file)
- commitlint.config.js - commitlint configuration
- esbuild.config.js - the build script - esbuild.config.js - the build script
- eslint.config.js - ESLint configuration - eslint.config.js - ESLint configuration
- jest.config.js - Jest configuration - jest.config.js - Jest configuration
- lint-staged.config.js - lint-staged configuration
- prettier.config.js - Prettier configuration
- svrjs.json - SVR.JS version, name, documentation URL, and statistics server collection endpoint URL - svrjs.json - SVR.JS version, name, documentation URL, and statistics server collection endpoint URL
## Contribute ## Contribute