A modern, enterprise-grade fullstack boilerplate providing standardized project structure and best practices for rapid development.
- Standardized directory structure for consistent organization
- Comprehensive documentation setup with clear categories
- Environment-specific configuration management
- Cross-platform application support (Web, Mobile, Server)
There are several ways to use this boilerplate:
- Download the ZIP file of this repository
- Extract it into your existing project directory
- Customize the structure and content according to your needs:
- Update project name and description in README.md
- Modify package.json with your project details
- Adjust the folder structure as needed
- Remove unnecessary directories and files
- Clone the template
git clone https://github.com/nesnilnehc/fullstack-project-boilerplate.git
cd fullstack-project-boilerplate- Remove the existing Git history
rm -rf .git- Initialize a new Git repository
git init-
Customize the project:
- Update project name and description in README.md
- Modify package.json with your project details
- Update LICENSE file with your information
- Configure environment-specific settings
- Update project documentation
-
Push to your repository
git remote add origin your-repository-url
git add .
git commit -m "Initial commit"
git push -u origin main- Click the "Use this template" button on GitHub
- Create a new repository using this template
- Clone your new repository
- Customize as needed following the steps above
.
├───dist # Compiled files
├───docs # Documentation files
│ ├───index.md # Documentation index
│ ├───guides # Development guides
│ │ ├───setup # Setup guides
│ │ │ ├───index.md # Setup guide index
│ │ │ ├───environment # Environment setup
│ │ │ │ ├───windows.md # Windows setup guide
│ │ │ │ ├───macos.md # macOS setup guide
│ │ │ │ └───linux.md # Linux setup guide
│ │ │ ├───dependencies # Dependencies setup
│ │ │ │ ├───node.md # Node.js setup
│ │ │ │ ├───docker.md # Docker setup
│ │ │ │ └───database.md # Database setup
│ │ │ └───ide # IDE configuration
│ │ │ ├───vscode.md # VS Code setup
│ │ │ └───intellij.md # IntelliJ setup
│ ├───architecture # System architecture
│ │ ├───overview
│ │ │ ├───introduction
│ │ │ │ ├───system-overview.md # System overview and goals
│ │ │ │ └───business-goals.md # Business requirements
│ │ │ ├───tech-stack
│ │ │ │ ├───frontend-stack.md # Frontend technology choices
│ │ │ │ ├───backend-stack.md # Backend technology choices
│ │ │ │ └───infrastructure-stack.md # Infrastructure technology
│ │ │ └───principles
│ │ │ ├───design-principles.md # Core design principles
│ │ │ └───coding-principles.md # Coding standards
│ │ ├───database
│ │ │ ├───models
│ │ │ │ ├───customer-model.md # Customer entity design
│ │ │ │ ├───contact-model.md # Contact entity design
│ │ │ │ ├───opportunity-model.md # Opportunity entity design
│ │ │ │ └───activity-model.md # Activity tracking model
│ │ │ ├───schemas
│ │ │ │ ├───schema-overview.md # Database schema overview
│ │ │ │ └───schema-migrations.md # Schema migration strategy
│ │ │ └───sharding
│ │ │ ├───sharding-strategy.md # Data sharding approach
│ │ │ └───data-distribution.md # Data distribution rules
│ │ ├───features
│ │ │ ├───auth
│ │ │ │ ├───authentication
│ │ │ │ │ ├───jwt-auth.md # JWT authentication design
│ │ │ │ │ └───sso-integration.md # SSO integration design
│ │ │ │ └───authorization
│ │ │ │ ├───rbac-design.md # Role-based access control
│ │ │ │ └───permission-matrix.md # Permission definitions
│ │ │ ├───i18n
│ │ │ │ ├───translation-strategy.md # Translation management
│ │ │ │ └───language-detection.md # Language detection logic
│ │ │ ├───storage
│ │ │ │ ├───file-storage.md # File storage design
│ │ │ │ └───cdn-integration.md # CDN configuration
│ │ │ └───search
│ │ │ ├───search-engine.md # Search engine design
│ │ │ └───indexing-strategy.md # Search indexing strategy
│ │ ├───security
│ │ │ ├───encryption
│ │ │ │ ├───data-encryption.md # Data encryption methods
│ │ │ │ └───key-management.md # Encryption key management
│ │ │ └───protocols
│ │ │ ├───security-protocols.md # Security protocols
│ │ │ └───compliance.md # Security compliance
│ │ ├───infrastructure
│ │ │ ├───network
│ │ │ │ ├───network-topology.md # Network architecture
│ │ │ │ └───load-balancing.md # Load balancing strategy
│ │ │ └───cloud
│ │ │ ├───cloud-services.md # Cloud service usage
│ │ │ └───scaling-strategy.md # Scaling approach
│ │ ├───diagrams
│ │ │ ├───system
│ │ │ │ ├───system-architecture.md # System architecture diagrams
│ │ │ │ └───component-diagram.md # Component relationships
│ │ │ └───sequence
│ │ │ ├───auth-flow.md # Authentication flow
│ │ │ └───order-process.md # Order processing flow
│ │ └───decisions
│ │ ├───records
│ │ │ ├───adr-001-auth-strategy.md # Authentication strategy decision
│ │ │ └───adr-002-database-choice.md # Database selection decision
│ │ └───proposals
│ │ ├───microservices-proposal.md # Microservices architecture
│ │ └───caching-strategy-proposal.md # Caching strategy
├───config # Project configuration files
│ ├───dev # Development environment
│ ├───prod # Production environment
│ └───test # Testing environment
├───docker # Docker configuration files
│ ├───compose # Docker compose files
│ │ ├───dev # Development compose files
│ │ └───prod # Production compose files
│ ├───config # Docker configurations
│ │ ├───nginx # Nginx configuration
│ │ └───redis # Redis configuration
│ └───services # Dockerfile for services
│ ├───backend # Backend service
│ ├───frontend # Frontend service
│ └───worker # Worker service
├───resources # Project resources
│ ├───images # Image assets
│ ├───fonts # Font files
│ ├───icons # Icon assets
│ └───templates # Template files
├───scripts # Scripts
├───src # Source files
│ ├───app-android # Android app source files
│ ├───app-ios # iOS app source files
│ ├───server # Server source files
│ ├───tools # Tools source files
│ ├───web # Web source files
│ └───web-hybrid # Web hybrid source files
├───.gitignore # Git ignore file
├───.gitlab-ci.yml # GitLab CI configuration file
├───.markdownlint.yaml # Markdownlint configuration file
├───.prettierrc.yaml # Prettier configuration file
├───CHANGELOG.md # Change log
├───LICENSE # License
└───README.md # Project description
If you make changes to the project's directory structure, please run the scripts/create_structure.sh script to ensure consistency.
bash scripts/create_structure.shCopyright © 2022-2024 NESNILNEHC
Licensed under the MIT License