How sai-deekshith-06/beautiify works
Project type and purpose
• This is a JAMstack-style, static documentation site (Beautiify) that showcases a large collection of HTML/CSS/JS UI components and animations.
• It’s hosted on Netlify, serves static HTML/CSS/JS assets, JSON metadata files, and uses a Netlify Function to fetch contributor data from GitHub.
File structure
• Top-level:
• index.html, style.css, script.js — the main entrypoint and global assets
• assets/ — static CSS, JS, HTML fragments, images, JSON metadata
• Components/ — hundreds of self-contained example folders (each with its own index.html, style.css, optional script.js)
• netlify/functions/contributors.js — serverless function that queries GitHub API
• components.json — manifest used by client-side code to discover categories and examples
• package.json, .github/, netlify.toml/_redirects — build/deploy configurations
• Patterns:
• Static file serving for UI demo pages
• Client-side dynamic rendering via script.js and assets/js_files/*.js
• JSON files as data source (assets/json_files/*.json)
• Serverless function for on-demand contributor data
README
• Confirms it’s purely HTML/CSS/JS ("Technology Used" = HTML, CSS, JavaScript).
• Live site on Netlify; lists pages like About, Components, FAQ, Contact.
• No traditional backend or database; data stored in JSON files & GitHub API.
Main components
a. Browser (Client)
b. Static Asset Hosting (Netlify CDN)
c. JSON Data Store (assets/json_files/*.json)
d. UI Demo Files (Components/* examples)
e. Netlify Function (contributors.js)
f. External Service (GitHub API)
Relationships and data flows
1. User’s browser requests index.html, CSS, script.js from Netlify CDN.
2. script.js (or commonScript) fetches components.json and category JSON files (assets/json_files/*.json) to build the Components page.
3. When the “Contributors” page loads, the client invokes the Netlify Function endpoint (/api/contributors) which in turn calls the GitHub API, then returns JSON to the client.
4. Browser dynamically injects data into the DOM to render lists, pages, assets.
Architectural patterns and design principles
• JAMstack: Prebuilt static files + client-side rendering + serverless functions.
• Component-based: Each UI example is an isolated folder with its own HTML/CSS/JS.
• “Data as code”: JSON files under assets/json_files drive the UI without a database.
• CDN + edge functions: Fast global delivery and on-demand dynamic data.
Relevant technologies/frameworks
• HTML5, CSS3, Vanilla JavaScript
• Netlify: Static hosting + Functions (serverless)
• Fetch API / XHR for JSON & function calls
• GitHub API (via serverless)
Details
• Fallback HTML pages in assets/html_files/.
• Role of components.json as the manifest.
• Directory structure as static content on the CDN.
• That there’s no monolithic backend—only serverless on demand.