Project Structure
Framework and generated project structure
Framework Structure
pest.jsadd
coreadd
wwwadd
assetsadd
pestjsadd
README.mdadd
Generated Project Structure
your-projectadd
srcadd
testsadd
scriptsadd
docsadd
package.jsonadd
tsconfig.jsonadd
.eslintrc.jsonadd
.envadd
.gitignoreadd
File Descriptions
Framework Files
- pestjs: CLI entry point
- core/cli/main.sh: Main CLI logic
- core/generators/: File generators
- core/utils/helpers.sh: Utility functions
Generated Files
- src/app.ts: Main Express application
- package.json: Dependencies and scripts
- tsconfig.json: TypeScript configuration
- .eslintrc.json: ESLint configuration
- .env: Environment variables
- .gitignore: Git ignore rules
Feature Module Structure
Each feature (like auth, users) contains:
featureadd
controllersadd
modelsadd
routesadd
servicesadd
index.tsadd
Feature Organization
Each feature (e.g., authentication, users) contains:
- controllers/ – API endpoint handlers
- models/ – Database schemas
- services/ – Business logic
- routes/ – Express routes
This structure ensures clean separation of concerns.