https://github.com/arsh342/cookbook
Cookbook: A modern recipe sharing platform built with React, HTML5, CSS3, Javascript and Firebase. Create, discover, and share recipes with a vibrant culinary community. Features user authentication, image uploads, and subscription tiers.
https://github.com/arsh342/cookbook
Last synced: 5 months ago
JSON representation
Cookbook: A modern recipe sharing platform built with React, HTML5, CSS3, Javascript and Firebase. Create, discover, and share recipes with a vibrant culinary community. Features user authentication, image uploads, and subscription tiers.
- Host: GitHub
- URL: https://github.com/arsh342/cookbook
- Owner: arsh342
- License: mit
- Created: 2024-09-01T15:57:47.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-29T06:31:25.000Z (over 1 year ago)
- Last Synced: 2025-06-03T18:06:07.547Z (about 1 year ago)
- Language: HTML
- Homepage: https://cookbookrecipes.vercel.app
- Size: 3.21 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cookbook - Recipe Sharing Platform
A modern web application for sharing and discovering recipes, built with React, Next.js, and Firebase.
## 🚀 Features
- **User Authentication**
- Email/password login
- Google sign-in integration
- User profile management
- **Recipe Management**
- Create and share recipes
- Upload recipe images
- Add detailed ingredients and instructions
- Browse community recipes
- **Subscription System**
- Free tier with basic features
- Premium tier with advanced features
- Secure payment processing
- **Modern UI/UX**
- Responsive design
- Dark/light mode support
- Intuitive navigation
- Real-time updates
## 🛠️ Tech Stack
- **Frontend**
- React 18
- Next.js 14
- Tailwind CSS
- shadcn/ui components
- TypeScript
- **Backend/Services**
- Firebase Authentication
- Firebase Firestore
- Firebase Storage
- Firebase Hosting
## 📦 Installation
1. **Clone the repository**
```bash
git clone https://github.com/yourusername/cookbook.git
cd cookbook
```
2. **Install dependencies**
```bash
npm install
```
3. **Set up environment variables**
Create a `.env.local` file in the root directory:
```
NEXT_PUBLIC_FIREBASE_API_KEY=your_api_key
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your_auth_domain
NEXT_PUBLIC_FIREBASE_PROJECT_ID=your_project_id
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your_storage_bucket
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your_messaging_sender_id
NEXT_PUBLIC_FIREBASE_APP_ID=your_app_id
```
4. **Start the development server**
```bash
npm run dev
```
5. **Open your browser**
Navigate to http://localhost:3000
## 📁 Project Structure
```
cookbook/
├── src/
│ ├── app/
│ │ ├── layout.tsx
│ │ ├── page.tsx
│ │ └── recipes/
│ ├── components/
│ │ ├── ui/
│ │ └── recipes/
│ ├── lib/
│ │ └── firebase.ts
│ └── styles/
│ └── globals.css
├── public/
├── firebase/
│ ├── storage.rules
│ └── firestore.rules
└── package.json
```
## 🔧 Configuration
### Firebase Setup
1. Create a new Firebase project
2. Enable Authentication services
3. Set up Firestore database
4. Configure Storage rules
5. Update security rules for production
### Development
```bash
# Run development server
npm run dev
# Run type checking
npm run type-check
# Run linting
npm run lint
# Run tests
npm run test
```
## 🚀 Deployment
1. **Build the application**
```bash
npm run build
```
2. **Deploy to Firebase**
```bash
npm run deploy
```
## 🤝 Contributing
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## 📝 License
This project is licensed under the MIT License - see the LICENSE file for details.
## 👥 Authors
- Arshdeep Singh - arsh342
## 🙏 Acknowledgments
- React Documentation
- Next.js Documentation
- Firebase Documentation
- shadcn/ui Components
- Tailwind CSS
## 📧 Contact
- Email: arshth134@gmail.com
- Project Link: https://cookbookv2-y8ir.vercel.app/
## 🔮 Future Features
- Recipe rating and review system
- Social sharing integration
- Advanced search and filtering
- Recipe collections and favorites
- Meal planning calendar
- Shopping list generation