/lunch

Recipes and tips from my mother

Primary LanguageTypeScriptMIT LicenseMIT

Lunch

Welcome to Lunch, a web application designed by myself, developed using Next.js and Tailwind. This project provides an interface to recipes for delicious meals, inspired by recipes from my mother. Recipes are stored as Markdown files, making it easy to add and manage.

Features

  • Recipe Collection: Create, store, and organize recipes in one place.
  • Markdown Support: Write recipes using Markdown formatting for easy readability and flexibility.

Getting Started

  1. Clone the repository: git clone https://github.com/naphteine/lunch.git
  2. Navigate to the project directory: cd lunch
  3. Install dependencies: yarn install
  4. Start the development server: yarn run dev
  5. Open your browser and visit: http://localhost:3000

Project Structure

  • /pages: Contains the application's pages and routing logic.
  • /components: Includes reusable React components used throughout the project.
  • /styles: Houses global styles and Tailwind CSS configuration files.
  • /public: Stores static assets such as images.
  • /_recipes: Stores recipes as Markdown files.

Technologies Used

  • Next.js
  • React
  • TypeScript
  • Tailwind
  • Markdown

Roadmap

  • Search Functionality: Quickly find recipes based on ingredients, cuisine or recipe name.
  • Responsive Design: Enjoy a seamless experience across different devices, ensuring easy access wherever you go.

Contributing

This is a private project. If you encounter any issues or have suggestions for improvement, please open an issue on the GitHub repository.

License

This project is licensed under the MIT License.

Trivial

The name of this project, "Lunch", is inspired by the film "Naked Lunch" and its source material, the novel by William S. Burroughs.