How ldelbel/music-store-website works
Project type and purpose
• This is a simple static front-end website (an online musical instruments store prototype) built with HTML, CSS (Sass), Bootstrap 4, and FontAwesome.
• There is no application server or database; it’s deployed as a set of static assets (HTML, CSS, fonts, images).
File structure
• Top-level:
• index.html, search.html – the two HTML pages served to users
• css/ – contains Sass build config, fonts, and the compiled styles.css
• images/ – static image assets
• .github/workflows/linters.yml – CI pipeline for style and code linting
• README.md, .gitignore
• Build tooling:
• sass CLI invoked via npm script (npm run compile:sass)
• stylelint config in css/stylelint.config.js
• Stickler config for CSS linting
README for additional insights
• Built with HTML, CSS (Sass), Bootstrap 4, FontAwesome
• Live demo hosted on GitHub Pages
• Developer uses Sass CLI globally and GitHub Actions for linting
Main components
a. Local Development Environment
• Developer workstation
• Tools: Code editor, Sass CLI, stylelint, Git
b. Version Control & CI
• GitHub Repository
• GitHub Actions (linters.yml) for stylelint and Stickler checks
c. Build Process
• Sass compiler transforms .scss → css/styles.css
d. Hosting
• GitHub Pages (static file hosting)
e. Client
• Web browser loading index.html/search.html and their CSS, fonts, images
Relationships and data flow
1. Developer writes HTML, Sass, commits to GitHub.
2. Push triggers GitHub Actions: run stylelint + Stickler.
3. Upon passing, code is deployed to GitHub Pages.
4. Client browser requests index.html or search.html.
5. Browser fetches styles.css, font files, images.
6. Sass source files are local only; production sees only compiled CSS.
Architectural patterns/design principles
• Static Website Architecture
• CI-as-code: GitHub Actions for linting
• Separation of concerns:
• HTML markup (index.html/search.html)
• Styles (Sass → CSS)
• Assets (fonts, images)
• Build pipeline: local compile vs. CI lint checks
Detail to capture
• Directory breakdown: css/ (fonts, stylelint config, styles.css), images/, HTML pages
• Build commands: npm run compile:sass
• CI workflow file location and purpose
• Technologies: Sass, Bootstrap 4, FontAwesome, GitHub Actions, GitHub Pages
• Client resource loading sequence (HTML → CSS → fonts/images)