Foodable will be an AI-powered web application designed to help users discover healthy and affordable food options tailored to their dietary needs and budget. The app offers personalized recommendations, recipe sharing, and grocery lists with nutritional insights.
- Personalized Recipe Suggestions: Discover recipes that meet your dietary preferences and budget.
- Custom Grocery Lists: Generate shopping lists from your recipes and dietary needs.
- Nutritional Insights: Get AI-assisted insights into nutritional content to make healthier choices.
- Authentication & Access Control: Secure user accounts using Clerk.js
- Frontend: Built with Next.js and styled using Tailwind CSS for a responsive UI.
- Backend: Node.js API with MongoDB Atlas as the database, which includes vector search capabilities.
- AI & Embedding: Uses OpenAI and MongoDB Atlas Vector Search.
- Deployment: Hosted on Vercel with CI/CD integration.
/project-root
├── /.github
├── /frontend # NextJS Front End Code
├── /__tests__ # Jest Tests
├── /cypress # Cypress Tests
├── /public # Public Data and Assets
├── /src # Source Code
├── /app # Page Routes and API Routes
├── /api # API Rotues
├── /assets # Assets (fonts, images)
├── /components # UI Components
├── /config # Configurations of Data
├── /hooks # Client Side Custom Hooks
├── /layouts # Client and Server Side Layouts
├── /lib
├── /hooks # Client Side Custom Hooks
├── /utils # Utility Functions for Various Things
├── /providers # Providers for Application
├── /server # Methods to Communicate with Server
├── /api # Fetch Methods to Communicate with API
├── /hooks # TanStack Hooks to Communicate with API
├── /stores # Zustand Stores
├── /types # Types for Data throughout Application
├── .env.local
├── /postman # Location of Export Postman Tests and Environment
└── README.md # Project documentation
Before starting local development or deployment, make sure you've properly created and configured the .env.local file in the root of the frontend directory.
You can use the provided env.txt file at the top level of the project as a reference.
- Prerequisites:
- Node.js
- MongoDB Atlas Account
- Clerk.js Account Setup
- Clone the repository:
git clone git@github.com:MrF1ow/foodable.git cd foodable - Install packages
npm install
- Ensure Build Process Works Correctly
npm run build
- Start The Application
npm start
- Access the App @:
http://localhost:8000
- Some features are still under development.
- Known issues may still exist. If you encounter any bugs or unexpected behavior, please report them via the
Issuestab. - The site is using development API keys, which may result in slower response times or limited functionality.
Visit: https://foodable.xyz