An open API service indexing awesome lists of open source software.

https://github.com/thesmartcooking/prototype

Static preview of the site built with Astro, featuring UI components and hosted on GitHub Pages
https://github.com/thesmartcooking/prototype

Last synced: 10 months ago
JSON representation

Static preview of the site built with Astro, featuring UI components and hosted on GitHub Pages

Awesome Lists containing this project

README

          

# Smart Cooking – Prototype

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 site, showcasing the user interface, design elements, and layout without backend or dynamic functionality.

---

## 🌟 About Smart Cooking

**Smart Cooking** is a project dedicated to helping everyone β€” especially students β€” cook healthy, enjoyable meals on a budget.

Our goal is to build a collaborative platform where users can share:

- πŸ₯˜ Recipes
- πŸ’‘ Tips & tricks
- πŸ§‘β€πŸ³ Practical cooking advice

We aim to make healthy, budget-friendly cooking accessible and fun, without requiring specialized culinary knowledge.

πŸ—“οΈ **Started:** June 2024
πŸš€ **Status:** In active development

## πŸ“¦ What’s in this Repository?

- Static frontend pages built using **Astro**
- Reusable UI components (e.g., headers, cards, buttons)
- Responsive layout and design previews
- Hosted via **GitHub Pages**

> [!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](https://thesmartcooking.github.io/Prototype/)

## πŸ› οΈ Tech Stack

- [Astro](https://astro.build) β€” Static site generator
- [GitHub Pages](https://pages.github.com) β€” Hosting platform
- [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
- 🧱 Visual Studio 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

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).
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).