EatMan

Setup your own meal planner.
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

[]

Have you ever faced the problem that you do not know what to cook today? Have you then thought for hours and rummaged through cookbooks? This is where EatMan comes in. He takes the decision away from you by making a random suggestion. Only dishes that EatMan knows and that you have entered yourself are taken into account.

Built With

• Bootstrap
• JQuery
• Composer
• Font Awesome
• Mustache

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• git
• apache
• php
• mysql

  sudo apt install git apache2 mysql-server php php-mysqli

Installation

Option 1: Run the automated installer

curl -s https://raw.githubusercontent.com/Kreisverkehr/EatMan/main/src/setup/install.sh | bash -s

Option 2: Manual install

1. Clone the repo

   cd /opt/
   git clone https://github.com/Kreisverkehr/EatMan.git

2. Install Composer

   cd EatMan/src/wwwroot
   ./../setup/installcomposer.sh

   https://getcomposer.org/download/
3. Install Dependencies

   php composer.phar install

4. Create Database

   sudo mysql -e "CREATE DATABASE EatMan"
   sudo mysql EatMan < ../setup/createdb.sql

5. Enter your mysql user in src/wwwroot/sys/settings.php

   <?php
   $db_user = "mysql_user";
   $db_pass = "mysql_super_secret_password";

6. Create symlink

   sudo ln -s /opt/EatMan/src/wwwroot/ /var/www/html/EatMan

Usage

• Click on "Add dish" do start adding your dishes.
• You are now ready to get suggestions from the start page. Just click "Make a suggestion!"

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/Kreisverkehr/EatMan