1.0
This commit is contained in:
65
README.md
Normal file
65
README.md
Normal file
@@ -0,0 +1,65 @@
|
||||
# 📖 The Recipe Box
|
||||
|
||||
A gorgeous, minimal cookbook website that stores your recipes as JSON files locally.
|
||||
|
||||
## ✨ Features
|
||||
|
||||
- **Beautiful UI** — Warm, editorial design inspired by vintage recipe cards
|
||||
- **JSON Storage** — All recipes saved as individual `.json` files in the `recipes/` folder
|
||||
- **Full CRUD** — Add, view, edit, and delete recipes
|
||||
- **Zero Database** — Everything is file-based, easy to backup and version control
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
1. **Install dependencies**
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
2. **Start the server**
|
||||
```bash
|
||||
npm start
|
||||
```
|
||||
|
||||
3. **Open your browser**
|
||||
```
|
||||
http://localhost:3000
|
||||
```
|
||||
|
||||
That's it! Your cookbook is ready. 🍳
|
||||
|
||||
## 📁 Recipe Format
|
||||
|
||||
Recipes are stored as JSON files in the `recipes/` folder:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "unique-recipe-id",
|
||||
"title": "Recipe Name",
|
||||
"category": "Dinner",
|
||||
"description": "A brief description",
|
||||
"servings": "4",
|
||||
"prepTime": "15 mins",
|
||||
"cookTime": "30 mins",
|
||||
"ingredients": [
|
||||
"First ingredient",
|
||||
"Second ingredient"
|
||||
],
|
||||
"instructions": [
|
||||
"Step one",
|
||||
"Step two"
|
||||
],
|
||||
"createdAt": "2025-03-12T10:00:00.000Z",
|
||||
"updatedAt": "2025-03-12T10:00:00.000Z"
|
||||
}
|
||||
```
|
||||
|
||||
## 💡 Tips
|
||||
|
||||
- **Backup recipes**: Just copy the entire `recipes/` folder
|
||||
- **Share recipes**: Send individual `.json` files to friends
|
||||
- **Version control**: Track your recipe evolution with git!
|
||||
|
||||
---
|
||||
|
||||
Made with 🧈 and ❤️
|
||||
Reference in New Issue
Block a user