🚀 Julian’s Web Garden
Here lies some re-usable components and tooling settings, taking advantage of Astro strengths as much as possible.
Focus is on common web patterns and progressive enhancements.
Astro is still in Beta, so is this collection.
Components API might change a bit, though not drastically.
Thanks for you understanding ✌️.
We’ve all been to the point of throwing valuable code when adopting new
shiny website frameworks.
That way, we can sprinkle advanced JS widgets as we like, with trendy UI framework, while things like global application utilities remain stable over time.
Vanilla means future-proofing our code, but it also bring the benefit of minuscule file sizes compared to “all-or-nothing” UI frameworks.
- 🚀 Julian’s Web Garden
- 🔗 Quick links
- ✅ Tests
- 🚧 To dos
- 🧫 Experimenting
- 🧑🚀 Development
🔗 Quick links
Deployed on Netlify via GitHub actions.
flowchart TB subgraph Pages Home(Home) Etc2("...") end subgraph Components subgraph Layouts Default('Default') Etc3("...") end subgraph Application SEO('SEO') Prefetch('Prefetch') Etc("...") end subgraph Modules Landing('Landing') SinglePackage('SinglePackage') Etc5("...") end subgraph Generic Link('Link') LicensesReport('LicensesReport') Etc4("...") end end Data(Data)-->Pages Application-->Layouts Generic-->Pages Modules-->Pages Generic-->Modules Generic-->Layouts Layouts-->Pages
- Pages: the base component entry point.
All other parts (layouts, generic components, modules…) and data are directly or indirectly gathered from here.
- Layout: Where your website shells lives. This is where you put your global navigation, footer…
Alternative layouts can be created like
- App-level component: used everywhere, anytime, for a given layout, which import them.
E.g. Color modes handler, breakpoints handler…
- Component: Ubiquitous general purpose, atomic components.
E.g. icons, images, links, maps, videos…
- Module: Complex set of components, forming a single purpose page view/section.
- Data: Local JSONs, Markdown files, remote APIs…
Should be fetched from pages. Note that this is not a hard rule or a technical limitation with Astro as with other frameworks.
Ultimately, this pattern makes data-flow easier to follow (“top -> down”), preventing spaghetti code, duplications and performance hogs.
These are global components which enhance or augment browser behavior and style, while providing useful utilities to developers, website-wide.
Generic extendables components.
A useful collection for web developers.
Features ESLint, Prettier, Stylelint, Commitlint…
For Astro, React, Vue, SCSS, TS…
- External / contact links
- External / contact links
🚧 To dos
- Fix default package import when possible, as client side JS breaks for now
import Tooltips from '@julian_cataldo/astro-tooltips/Tooltips.astro';
import Tooltips from '@julian_cataldo/astro-tooltips';
- Find a way to launch only necessary tests when versioning
- Implement dev / prod mode for debugging outputs
- Rehaul demo website
- Evaluate PNPM workspaces + tools for replacing Lerna version/publish?
- Fix Lerna conventional commits not following breaking changes for versioning
- Full no JS compatibility / fallbacks checks
- Fix CSS theme not loading
- Fix flash of unstyled text (critical font loading strategy)
- Website full theme switcher, in addition to color dark / light variants.
- Feature flag manager
- Copy to clipboard
- Algolia search
- SSR Mermaid
# Clone mono-repository git clone https://github.com/JulianCataldo/web-garden # Scripts located in root ./package.json # Bootstrap all packages dependencies pnpm install --recursive # Launch implementations demo website pnpm run demo # Cypress: Open dev GUI pnpm run cypress:open # Cypress: Run test suite pnpm run cypress:run # Linkinator: Run links checker with report pnpm run test:links # Pre-release, does: # 1. Packages bump based on commits # 2. Tagging releases # 3. Git push pnpm run version # Release updated packages on NPM public registry pnpm run release