Code Monkey home page Code Monkey logo

lunch's Introduction

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.

lunch's People

Contributors

naphteine avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.