From 477f3f62b4d64e242d85eb33b0c0e7aa3cc786b7 Mon Sep 17 00:00:00 2001 From: Vianpyro Date: Fri, 16 May 2025 13:45:18 +0000 Subject: [PATCH 1/4] Update README to reflect project details and structure for Smart Cooking prototype --- README.md | 83 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 48 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index ff19a3e..93584dc 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,61 @@ -# Astro Starter Kit: Basics +# Smart Cooking – Prototype -```sh -npm create astro@latest -- --template basics -``` +Static preview of the site built with [Astro](https://astro.build), featuring UI components and hosted on [GitHub Pages](https://pages.github.com). -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics) -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json) +This repository serves as the **visual prototype** of the [Smart Cooking](https://github.com/TheSmartCooking) project. It provides a static, frontend-only version of the website, showcasing the user interface, design elements, and layout without backend or dynamic functionality. -> πŸ§‘β€πŸš€ **Seasoned astronaut?** Delete this file. Have fun! +--- -![just-the-basics](https://github.com/withastro/astro/assets/2244813/a0a5533c-a856-4198-8470-2d67b1d7c554) +## 🌟 About Smart Cooking -## πŸš€ Project Structure +**Smart Cooking** is a project dedicated to helping everyone β€” especially students β€” cook healthy, enjoyable meals on a budget. -Inside of your Astro project, you'll see the following folders and files: +Our goal is to build a collaborative platform where users can share: -```text -/ -β”œβ”€β”€ public/ -β”‚ └── favicon.svg -β”œβ”€β”€ src/ -β”‚ β”œβ”€β”€ layouts/ -β”‚ β”‚ └── Layout.astro -β”‚ └── pages/ -β”‚ └── index.astro -└── package.json -``` +- πŸ₯˜ Recipes +- πŸ’‘ Tips & tricks +- πŸ§‘β€πŸ³ Practical cooking advice -To learn more about the folder structure of an Astro project, refer to [our guide on project structure](https://docs.astro.build/en/basics/project-structure/). +We aim to make healthy, budget-friendly cooking accessible and fun, without requiring specialized culinary knowledge. -## 🧞 Commands +πŸ—“οΈ **Started:** June 2024 +πŸš€ **Status:** In active development -All commands are run from the root of the project, from a terminal: +## πŸ“¦ What’s in this Repository? -| Command | Action | -| :------------------------ | :----------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:4321` | -| `npm run build` | Build your production site to `./dist/` | -| `npm run preview` | Preview your build locally, before deploying | -| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | -| `npm run astro -- --help` | Get help using the Astro CLI | +- Static frontend pages built using **Astro** +- Reusable UI components (e.g., headers, cards, buttons) +- Responsive layout and design previews +- Hosted via **GitHub Pages** -## πŸ‘€ Want to learn more? +> πŸ’‘ This repo does not include the backend logic, authentication, or database features. For that, see our main repositories and documentation below. -Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). +## 🧭 Project Resources + +- πŸ“š [Smart Cooking Wiki](https://github.com/TheSmartCooking/.github/wiki) β€” Full documentation, database models, API reference, and development guides. +- 🏠 [TheSmartCooking Organization](https://github.com/TheSmartCooking) β€” Explore all repositories related to the project. +- 🌐 [GitHub Pages Preview](#) β€” _[Add the live preview link here if available]_. + +## πŸ› οΈ Tech Stack + +- [Astro](https://astro.build) β€” Static site generator +- [GitHub Pages](https://pages.github.com) β€” Hosting platform +- [Tailwind CSS](https://tailwindcss.com) _(if applicable)_ +- [Markdown](https://www.markdownguide.org/) β€” Content formatting + +## 🀝 Contributing + +If you’d like to contribute to the UI or suggest improvements: + +1. Fork this repository +2. Create a feature branch +3. Submit a pull request with a clear description + +We welcome feedback, designs, and accessibility improvements! + +## πŸ“„ License + +This repository is licensed under the [MIT License](LICENSE). + +Thanks for checking out **Smart Cooking – Prototype**! +For full-stack development, roadmap, and community efforts, head over to our [Wiki](https://github.com/TheSmartCooking/.github/wiki). From 26abc00301a46b5176d34637438404136daa7ad3 Mon Sep 17 00:00:00 2001 From: Vianpyro Date: Fri, 16 May 2025 14:04:12 +0000 Subject: [PATCH 2/4] Update README and package-lock.json for project clarity and dependency updates --- README.md | 33 ++++++++++++++++++++---- package-lock.json | 64 +++++++++++++++++++++++------------------------ 2 files changed, 60 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 93584dc..c303ae4 100644 --- a/README.md +++ b/README.md @@ -28,20 +28,40 @@ We aim to make healthy, budget-friendly cooking accessible and fun, without requ - Responsive layout and design previews - Hosted via **GitHub Pages** -> πŸ’‘ This repo does not include the backend logic, authentication, or database features. For that, see our main repositories and documentation below. +> [!NOTE] +> This repo does not include the backend logic, authentication, or database features. For that, see our main repositories and documentation below. ## 🧭 Project Resources - πŸ“š [Smart Cooking Wiki](https://github.com/TheSmartCooking/.github/wiki) β€” Full documentation, database models, API reference, and development guides. - 🏠 [TheSmartCooking Organization](https://github.com/TheSmartCooking) β€” Explore all repositories related to the project. -- 🌐 [GitHub Pages Preview](#) β€” _[Add the live preview link here if available]_. +- 🌐 [GitHub Pages Preview](https://thesmartcooking.github.io/Prototype/) ## πŸ› οΈ Tech Stack - [Astro](https://astro.build) β€” Static site generator - [GitHub Pages](https://pages.github.com) β€” Hosting platform -- [Tailwind CSS](https://tailwindcss.com) _(if applicable)_ -- [Markdown](https://www.markdownguide.org/) β€” Content formatting +- [Docker](https://www.docker.com) β€” Dev container support +- [Dev Containers](https://containers.dev) β€” Reproducible development environment +- [GitHub Actions](https://docs.github.com/en/actions) β€” CI/CD and code quality workflows + +## πŸ§ͺ Tooling & Automation + +This repository includes development and automation tooling: + +### βš™οΈ Devcontainer + +A Docker-based development container is defined in `.devcontainer/` for consistent onboarding and live-preview development. Features: + +- 🐧 Alpine-based image with Node.js and Bash +- 🧱 VS Code extensions auto-installed (Astro, Trigger Tasks on Save) +- πŸš€ Auto-forwarded port for local live server + +### βœ… GitHub Workflows + +- `deploy-to-pages.yml`: Build and deploy site to GitHub Pages on release +- `devcontainer-verification.yml`: Scan and validate `.devcontainer` image using a reusable workflow +- `super-linter.yml`: Run [Super Linter](https://github.com/github/super-linter) for static analysis and code consistency ## 🀝 Contributing @@ -55,7 +75,10 @@ We welcome feedback, designs, and accessibility improvements! ## πŸ“„ License -This repository is licensed under the [MIT License](LICENSE). +This **repository** is licensed under the [MIT License](LICENSE). +Please note that other repositories in the Smart Cooking project may use different licenses. Refer to the license file in each individual repository for details. + +--- Thanks for checking out **Smart Cooking – Prototype**! For full-stack development, roadmap, and community efforts, head over to our [Wiki](https://github.com/TheSmartCooking/.github/wiki). diff --git a/package-lock.json b/package-lock.json index f4005e4..24b46cd 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1216,60 +1216,60 @@ ] }, "node_modules/@shikijs/core": { - "version": "3.4.1", - "resolved": "https://registry.npmjs.org/@shikijs/core/-/core-3.4.1.tgz", - "integrity": "sha512-GCqSd3KXRTKX1sViP7fIyyyf6do2QVg+fTd4IT00ucYCVSKiSN8HbFbfyjGsoZePNKWcQqXe4U4rrz2IVldG5A==", + "version": "3.4.2", + "resolved": "https://registry.npmjs.org/@shikijs/core/-/core-3.4.2.tgz", + "integrity": "sha512-AG8vnSi1W2pbgR2B911EfGqtLE9c4hQBYkv/x7Z+Kt0VxhgQKcW7UNDVYsu9YxwV6u+OJrvdJrMq6DNWoBjihQ==", "license": "MIT", "dependencies": { - "@shikijs/types": "3.4.1", + "@shikijs/types": "3.4.2", "@shikijs/vscode-textmate": "^10.0.2", "@types/hast": "^3.0.4", "hast-util-to-html": "^9.0.5" } }, "node_modules/@shikijs/engine-javascript": { - "version": "3.4.1", - "resolved": "https://registry.npmjs.org/@shikijs/engine-javascript/-/engine-javascript-3.4.1.tgz", - "integrity": "sha512-oGvRqN3Bsk+cGzmCb/5Kt/LfD7uyA8vCUUawyqmLti/AYNV7++zIZFEW8JwW5PrpPNWWx9RcZ/chnYLedzlVIQ==", + "version": "3.4.2", + "resolved": "https://registry.npmjs.org/@shikijs/engine-javascript/-/engine-javascript-3.4.2.tgz", + "integrity": "sha512-1/adJbSMBOkpScCE/SB6XkjJU17ANln3Wky7lOmrnpl+zBdQ1qXUJg2GXTYVHRq+2j3hd1DesmElTXYDgtfSOQ==", "license": "MIT", "dependencies": { - "@shikijs/types": "3.4.1", + "@shikijs/types": "3.4.2", "@shikijs/vscode-textmate": "^10.0.2", "oniguruma-to-es": "^4.3.3" } }, "node_modules/@shikijs/engine-oniguruma": { - "version": "3.4.1", - "resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-3.4.1.tgz", - "integrity": "sha512-p8I5KWgEDUcXRif9JjJUZtNeqCyxZ8xcslecDJMigsqSZfokwqQIsH4aGpdjzmDf8LIWvT+C3TCxnJQVaPmCbQ==", + "version": "3.4.2", + "resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-3.4.2.tgz", + "integrity": "sha512-zcZKMnNndgRa3ORja6Iemsr3DrLtkX3cAF7lTJkdMB6v9alhlBsX9uNiCpqofNrXOvpA3h6lHcLJxgCIhVOU5Q==", "license": "MIT", "dependencies": { - "@shikijs/types": "3.4.1", + "@shikijs/types": "3.4.2", "@shikijs/vscode-textmate": "^10.0.2" } }, "node_modules/@shikijs/langs": { - "version": "3.4.1", - "resolved": "https://registry.npmjs.org/@shikijs/langs/-/langs-3.4.1.tgz", - "integrity": "sha512-v5A5ApJYcrcPLHcwAi0bViUU+Unh67UaXU9gGX3qfr2z3AqlqSZbC00W/3J4+tfGJASzwrWDro2R1er6SsCL1Q==", + "version": "3.4.2", + "resolved": "https://registry.npmjs.org/@shikijs/langs/-/langs-3.4.2.tgz", + "integrity": "sha512-H6azIAM+OXD98yztIfs/KH5H4PU39t+SREhmM8LaNXyUrqj2mx+zVkr8MWYqjceSjDw9I1jawm1WdFqU806rMA==", "license": "MIT", "dependencies": { - "@shikijs/types": "3.4.1" + "@shikijs/types": "3.4.2" } }, "node_modules/@shikijs/themes": { - "version": "3.4.1", - "resolved": "https://registry.npmjs.org/@shikijs/themes/-/themes-3.4.1.tgz", - "integrity": "sha512-XOJgs55mVVMZtNVJx1NVmdcfXG9HIyZGh7qpCw/Ok5UMjWgkmb8z15TgcmF3ItvHItijiIMl9BLcNO/tFSGl1w==", + "version": "3.4.2", + "resolved": "https://registry.npmjs.org/@shikijs/themes/-/themes-3.4.2.tgz", + "integrity": "sha512-qAEuAQh+brd8Jyej2UDDf+b4V2g1Rm8aBIdvt32XhDPrHvDkEnpb7Kzc9hSuHUxz0Iuflmq7elaDuQAP9bHIhg==", "license": "MIT", "dependencies": { - "@shikijs/types": "3.4.1" + "@shikijs/types": "3.4.2" } }, "node_modules/@shikijs/types": { - "version": "3.4.1", - "resolved": "https://registry.npmjs.org/@shikijs/types/-/types-3.4.1.tgz", - "integrity": "sha512-4flT+pToGqRBb0UhGqXTV7rCqUS3fhc8z3S2Djc3E5USKhXwadeKGFVNB2rKXfohlrEozNJMtMiZaN8lfdj/ZQ==", + "version": "3.4.2", + "resolved": "https://registry.npmjs.org/@shikijs/types/-/types-3.4.2.tgz", + "integrity": "sha512-zHC1l7L+eQlDXLnxvM9R91Efh2V4+rN3oMVS2swCBssbj2U/FBwybD1eeLaq8yl/iwT+zih8iUbTBCgGZOYlVg==", "license": "MIT", "dependencies": { "@shikijs/vscode-textmate": "^10.0.2", @@ -4444,17 +4444,17 @@ } }, "node_modules/shiki": { - "version": "3.4.1", - "resolved": "https://registry.npmjs.org/shiki/-/shiki-3.4.1.tgz", - "integrity": "sha512-PSnoczt+iWIOB4iRQ+XVPFtTuN1FcmuYzPgUBZTSv5pC6CozssIx2M4O5n4S9gJlUu9A3FxMU0ZPaHflky/6LA==", + "version": "3.4.2", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-3.4.2.tgz", + "integrity": "sha512-wuxzZzQG8kvZndD7nustrNFIKYJ1jJoWIPaBpVe2+KHSvtzMi4SBjOxrigs8qeqce/l3U0cwiC+VAkLKSunHQQ==", "license": "MIT", "dependencies": { - "@shikijs/core": "3.4.1", - "@shikijs/engine-javascript": "3.4.1", - "@shikijs/engine-oniguruma": "3.4.1", - "@shikijs/langs": "3.4.1", - "@shikijs/themes": "3.4.1", - "@shikijs/types": "3.4.1", + "@shikijs/core": "3.4.2", + "@shikijs/engine-javascript": "3.4.2", + "@shikijs/engine-oniguruma": "3.4.2", + "@shikijs/langs": "3.4.2", + "@shikijs/themes": "3.4.2", + "@shikijs/types": "3.4.2", "@shikijs/vscode-textmate": "^10.0.2", "@types/hast": "^3.0.4" } From 0ab1daecfd558061a339fc111544e26d18ab1dae Mon Sep 17 00:00:00 2001 From: Vianpyro Date: Fri, 16 May 2025 14:19:27 +0000 Subject: [PATCH 3/4] Fix formatting in README and update VSCode settings for whitespace management --- .vscode/settings.json | 1 + README.md | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 82eb381..1fe30a7 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,5 +1,6 @@ { "editor.insertSpaces": true, + "files.trimTrailingWhitespace": true, "triggerTaskOnSave.tasks": { "Prettify Current File": ["*"] } diff --git a/README.md b/README.md index c303ae4..9dcb680 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Our goal is to build a collaborative platform where users can share: We aim to make healthy, budget-friendly cooking accessible and fun, without requiring specialized culinary knowledge. -πŸ—“οΈ **Started:** June 2024 +πŸ—“οΈ **Started:** June 2024 πŸš€ **Status:** In active development ## πŸ“¦ What’s in this Repository? @@ -75,10 +75,10 @@ We welcome feedback, designs, and accessibility improvements! ## πŸ“„ License -This **repository** is licensed under the [MIT License](LICENSE). +This **repository** is licensed under the [MIT License](LICENSE). Please note that other repositories in the Smart Cooking project may use different licenses. Refer to the license file in each individual repository for details. --- -Thanks for checking out **Smart Cooking – Prototype**! +Thanks for checking out **Smart Cooking – Prototype**! For full-stack development, roadmap, and community efforts, head over to our [Wiki](https://github.com/TheSmartCooking/.github/wiki). From 6ba78b900ff0979ae45243070b0f87e81ce2b6ea Mon Sep 17 00:00:00 2001 From: Vianpyro Date: Tue, 20 May 2025 23:40:27 +0000 Subject: [PATCH 4/4] Update README for clarity and consistency in language --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9dcb680..380ec7c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Static preview of the site built with [Astro](https://astro.build), featuring UI components and hosted on [GitHub Pages](https://pages.github.com). -This repository serves as the **visual prototype** of the [Smart Cooking](https://github.com/TheSmartCooking) project. It provides a static, frontend-only version of the website, showcasing the user interface, design elements, and layout without backend or dynamic functionality. +This repository serves as the **visual prototype** of the [Smart Cooking](https://github.com/TheSmartCooking) project. It provides a static, frontend-only version of the site, showcasing the user interface, design elements, and layout without backend or dynamic functionality. --- @@ -54,7 +54,7 @@ This repository includes development and automation tooling: A Docker-based development container is defined in `.devcontainer/` for consistent onboarding and live-preview development. Features: - 🐧 Alpine-based image with Node.js and Bash -- 🧱 VS Code extensions auto-installed (Astro, Trigger Tasks on Save) +- 🧱 Visual Studio Code extensions auto-installed (Astro, Trigger Tasks on Save) - πŸš€ Auto-forwarded port for local live server ### βœ… GitHub Workflows