gentelella/CLEAN_BASE_PROJECT.md

3.0 KiB

Clean Base Project - Gentelella Admin Template

This repository has been cleaned up to provide a minimal base project for the Gentelella admin template, suitable for starting new development projects.

What Was Removed

๐Ÿ—‘๏ธ Pre-built Files & Dependencies

  • vendors/ - All Bower-managed third-party dependencies (jQuery, Bootstrap, etc.)
  • production/css/ - Pre-built CSS files
  • production/js/ - Pre-built JavaScript files
  • build/css/* - Pre-compiled CSS assets
  • build/js/* - Pre-compiled JavaScript assets
  • build/images/ - Pre-built image assets
  • docs/ - Documentation website files

๐Ÿงน Configuration Files

  • bower.json - Bower package configuration
  • .bowerrc - Bower settings
  • .DS_Store - macOS system files

What Remains

โœ… Essential Source Files

  • src/scss/ - SCSS source stylesheets
  • src/js/ - JavaScript source files
  • production/*.html - HTML template pages
  • production/images/ - Template images and assets

โœ… Development Tools

  • gulpfile.js - Build configuration (updated for modern Sass)
  • package.json - npm dependencies and scripts
  • .gitignore - Updated to ignore build outputs

Current Project Structure

gentelella/
โ”œโ”€โ”€ src/                    # ๐Ÿ”ง Source files (edit these)
โ”‚   โ”œโ”€โ”€ scss/              # SCSS stylesheets
โ”‚   โ””โ”€โ”€ js/                # JavaScript source
โ”œโ”€โ”€ build/                 # ๐Ÿ“ฆ Generated assets (ignored by git)
โ”‚   โ”œโ”€โ”€ css/              # Will contain compiled CSS
โ”‚   โ””โ”€โ”€ js/               # Will contain compiled JS
โ”œโ”€โ”€ production/           # ๐Ÿ“„ HTML templates
โ”‚   โ”œโ”€โ”€ *.html           # Template pages
โ”‚   โ””โ”€โ”€ images/          # Template assets
โ”œโ”€โ”€ gulpfile.js          # ๐Ÿ› ๏ธ Build configuration
โ”œโ”€โ”€ package.json         # ๐Ÿ“‹ npm dependencies
โ””โ”€โ”€ .gitignore          # ๐Ÿšซ Git ignore rules

Getting Started

  1. Install dependencies:

    npm install
    
  2. Build assets:

    npx gulp sass sass-minify scripts
    
  3. Start development server:

    npx gulp default
    

Benefits of This Clean Setup

  • โœ… Minimal repository size - No vendor dependencies or build artifacts
  • โœ… Modern build tools - Updated to use Dart Sass instead of deprecated Ruby Sass
  • โœ… Reproducible builds - All assets generated from source
  • โœ… Version control friendly - Only source files are tracked
  • โœ… Easy to customize - Clean separation between source and output
  • โœ… npm-only workflow - No need for Bower or Ruby dependencies

Notes

  • The build/ directory will be created automatically during the build process
  • All external dependencies should now be managed through npm instead of Bower
  • HTML templates in production/ still reference the built CSS/JS files in build/
  • This setup provides a clean foundation for building custom admin interfaces