https://github.com/ivankiral/cookmark
Cookmark is a responsive recipe book web app built with SolidJS/SolidStart, featuring fuzzy search, filtering, static site generation, and deployable to GitHub Pages
https://github.com/ivankiral/cookmark
cook-book recipe-book recipe-book-application solidjs solidstart static static-sites
Last synced: 5 months ago
JSON representation
Cookmark is a responsive recipe book web app built with SolidJS/SolidStart, featuring fuzzy search, filtering, static site generation, and deployable to GitHub Pages
- Host: GitHub
- URL: https://github.com/ivankiral/cookmark
- Owner: IvanKiral
- Created: 2025-08-15T08:21:14.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-10-02T16:46:35.000Z (5 months ago)
- Last Synced: 2025-10-02T18:20:43.561Z (5 months ago)
- Topics: cook-book, recipe-book, recipe-book-application, solidjs, solidstart, static, static-sites
- Language: TypeScript
- Homepage: https://ivankiral.github.io/cookmark/en/
- Size: 2.69 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Cookmark 🍳
A modern, responsive recipe book web application built with SolidJS/SolidStart.
## ✨ Features
- **Fuzzy Search** - Find recipes quickly with intelligent search across titles, ingredients, and tags
- **Advanced Filtering** - Filter by difficulty level, cooking time, and tags
- **Static Site Generation** - Optimized for deployment on GitHub Pages
## 🚀 Quick Start
### Prerequisites
- Node.js 22+ and npm installed on your system
### Development
1. Clone the repository:
```bash
git clone https://github.com/yourusername/cookmark.git
cd cookmark
```
2. Install dependencies:
```bash
npm ci
```
3. Start the development server:
```bash
npm run dev
```
4. Open your browser and navigate to `http://localhost:3000/cookmark`
### Building for Production
Build the static site for GitHub Pages deployment:
```bash
npm run build
```
The built files will be in the `.output` directory, ready for deployment.
## 📦 Use as Template
Want to create your own recipe book? Use degit to scaffold a new project from this template:
```bash
npx degit yourusername/cookmark my-recipe-book
cd my-recipe-book
npm install
```
## 📝 Adding Recipes
Recipes are stored in `src/data/recipes/` as TypeScript files. Each recipe follows a structured format:
```typescript
export const myRecipe: Recipe = {
slug: "my-recipe",
difficulty: "easy",
prepTime: 15,
cookTime: 30,
servings: 4,
tags: ["vegetarian", "quick"],
// Additional fields defined per locale
}
```
## 🚢 Deployment
This project is designed to be deployed as a static site on GitHub Pages. Check [deploy script](./.github/workflows//deploy.yml) to see how it can be deployed.
## 🤝 Contributing
Contributions are welcome! Feel free to submit issues and pull requests.
## 📄 License
MIT License - feel free to use this project for your own recipe collection!