Skip to content

Cookmark is a responsive recipe book web app built with SolidJS/SolidStart, featuring fuzzy search, filtering, static site generation, and deployable to GitHub Pages

Notifications You must be signed in to change notification settings

IvanKiral/cookmark

Repository files navigation

Cookmark 🍳

A modern, responsive recipe book web application built with SolidJS/SolidStart.

A GIF showcasing the Cookmark app

✨ 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:
git clone https://github.com/yourusername/cookmark.git
cd cookmark
  1. Install dependencies:
npm ci
  1. Start the development server:
npm run dev 
  1. Open your browser and navigate to http://localhost:3000/cookmark

Building for Production

Build the static site for GitHub Pages deployment:

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:

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:

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 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!

About

Cookmark is a responsive recipe book web app built with SolidJS/SolidStart, featuring fuzzy search, filtering, static site generation, and deployable to GitHub Pages

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published