-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
12 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,26 +16,27 @@ Try it out at https://app.tamariapp.com | |
Create your own account or sign in with the demo credentials. | ||
|
||
## Features | ||
- **Create User Accounts.** Login with an email and password. If configured on the instance, account passwords can be reset by sending a reset request to the email associated with your account. | ||
- **Store, View, Search, and Share Recipes.** For a single recipe, you can save a title, category, description, time estimates, servings, URL, ingredients, instructions, and a photo. If you don’t upload a photo, Tamari will assign a random cooking-themed placeholder. On the detail page for a recipe, you can click to cross off completed ingredients and instruction steps while you are cooking. Search-as-you-type functionality enables you to find the recipe you are looking for as quickly as possible. Recipes are only visible while logged in by default, however you can make a recipe public and share the URL with anyone. | ||
- **Organize.** Mark recipes as Favorites for easy access. Assign categories to recipes and browse by category. | ||
- **Explore.** Browse and search a collection of over 109,000 recipes from 50 recipe sharing websites. When you browse a recipe in Explore, Tamari will fetch and parse the relevant data from the URL without requiring you to visit the webpage. Import a recipe into My Recipes with the click of a button. | ||
- **Make Shopping Lists.** Make a shopping list for each store you shop at. Add all ingredients for a specific recipe to a shopping list with the click of a button. Click an item on a shopping list to mark it as completed. | ||
- **Plan Meals.** Use the Meal Planner to keep on top of what you plan to cook for the week. The Schedule button can assign a recipe being viewed to a date up to 30 days in advance. | ||
- **Customize.** Choose to display large photos to show off your recipes to friends, or smaller photos to fit more recipes on the screen. Sort recipes by title or by date added. Use the light or dark theme. Select between four account profile pictures. Set an accent color that applies to most buttons and many elements throughout the app. For a Tamari instance, some configuration options can be customized such as recipes per page and dynamic loading of images. | ||
- **Access on any Device.** Tamari is designed to function well on any desktop, laptop, tablet, or smartphone. | ||
- **Create User Accounts.** Login with an email and password. If enabled, easily reset forgotten passwords via email. | ||
- **Store, View, Search, and Share Recipes.** For a single recipe, you can save a title, category, description, time estimates, servings, URL, nutrition info, ingredients, instructions, and a photo. If no photo is uploaded, a random cooking-themed placeholder is assigned. Mark off completed ingredients on the recipe detail page for seamless cooking. Quickly find recipes with real-time "search-as-you-type" functionality. Recipes are only visible while logged in by default, however you can make a recipe public and share the URL with anyone. | ||
- **Organize.** Mark recipes as Favorites for quick access. Categorize recipes and browse by category. | ||
- **Explore.** Browse and search a collection of over 109,000 recipes from 50 recipe sharing websites. Import a recipe into "My Recipes" with one click. | ||
- **Create Shopping Lists.** Organize shopping lists for each store. Add all ingredients from a recipe to a shopping list with one click. Check off items as you shop. | ||
- **Plan Meals.** Plan your meals for the week using the Meal Planner. Assign recipes to specific dates up to 30 days in advance. | ||
- **Customize.** Choose to display large photos to show off your recipes to friends, or smaller photos to fit more recipes on the screen. Sort recipes by title or date added. Switch between light and dark themes. Pick from four profile pictures and customize your account's accent color. Configure instance-wide settings like recipes per page or dynamic image loading. | ||
- **REST API.** Access a comprehensive API to manage recipes, shopping lists, and meal plans programmatically. | ||
- **Access on any Device.** Enjoy a seamless experience on desktops, laptops, tablets, and smartphones. | ||
|
||
## Installing with Docker 🐳 | ||
This creates a 'tamariappdata' volume for persistent storage. | ||
``` | ||
docker run -d --restart=always -p 4888:4888 -v tamariappdata:/app/appdata --name tamari alexbates/tamari:0.9 | ||
docker run -d --restart=always -p 4888:4888 -v tamariappdata:/app/appdata --name tamari alexbates/tamari:1.0 | ||
``` | ||
Tamari is now running! Go to http://localhost:4888 | ||
|
||
### Alternative Command with Mail Settings | ||
Use this command instead if you wish to enable password reset requests via email. Replace variables with settings for an email account you control. | ||
``` | ||
docker run -d -e MAIL_SERVER=mail.example.com -e MAIL_PORT=587 -e MAIL_USE_TLS=1 -e [email protected] -e MAIL_PASSWORD=yourpassword --restart=always -p 4888:4888 -v tamariappdata:/app/appdata --name tamari alexbates/tamari:0.9 | ||
docker run -d -e MAIL_SERVER=mail.example.com -e MAIL_PORT=587 -e MAIL_USE_TLS=1 -e [email protected] -e MAIL_PASSWORD=yourpassword --restart=always -p 4888:4888 -v tamariappdata:/app/appdata --name tamari alexbates/tamari:1.0 | ||
``` | ||
|
||
## Manual Installation | ||
|
@@ -75,4 +76,4 @@ For Docker, if using tamariappdata (previously tamaristorage) volume, files may | |
/var/lib/docker/volumes/tamariappdata/_data/app.db | ||
/var/lib/docker/volumes/tamariappdata/_data/migrations | ||
/var/lib/docker/volumes/tamariappdata/_data/recipe-photos | ||
``` | ||
``` |