Welcome to ALX_Project — your next-generation recipe discovery and meal planning platform. Designed for passionate home cooks, foodies, and culinary explorers, this project combines a modern user experience with powerful features to help you discover, plan, and share amazing meals.
ALX Project helps home cooks find recipes by ingredient or mood, plan weekly meals, generate shopping lists, and save favorites to a personal dashboard. It ships with a clean responsive UI and three themes (Light, Dark, Floral).
- A single-page React app powered by Vite
- Components in
src/components/
and pages insrc/pages/
- Static assets and screenshots in
public/
(used below)
AI Recipe Finder
Meal Planner
Themes (Light / Dark / Floral)
- Search recipes by ingredient, cuisine, or dietary need
- Detailed recipe pages (ingredients, steps, nutrition)
- Save favorites and view them in a personal dashboard
- Weekly meal planner with shopping list export
- Submit recipes and read the built-in blog
- AI-powered recipe suggestions
These commands assume Git and Node.js are installed. On Windows PowerShell, run the following in the project folder:
git clone https://github.com/GziXnine/ALX_Project.git
cd ALX_Project
npm install
npm run dev
Open the Vite dev server URL shown in the terminal (typically http://localhost:5173
).
Available npm scripts (see package.json
):
npm run dev
— start the dev servernpm run build
— build production assetsnpm run preview
— preview the production build locallynpm run lint
— run ESLint
Small focused PRs are best. Suggested flow:
- Fork the repo and create a branch for your change
- Run the app locally and add tests or a UI screenshot if relevant
- Open a PR describing the change and include screenshots for UI work
I can add a CONTRIBUTING.md
and PR template if you'd like.
This project is licensed under the BSD 3-Clause License — see the LICENSE
file.
For questions or feedback, open an issue or visit the GitHub profile: GziXnine.
Happy cooking 🍳