cgiacofei/TandoorRecipes
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
vabene1111 2018-06-06 20:27:04 +00:00
parent e8f9965255
commit 058dcebd1c
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -1,33 +1,33 @@
#Recipies # Recipies
Recipes is a Django application that allows categorization and tagging of arbitrary numbers of recipes (or in fact any other file) in a storage backend. Recipes is a Django application that allows categorization and tagging of arbitrary numbers of recipes (or in fact any other file) in a storage backend.
Currently the only supported storage backend is dropbox, but this can easily be changed as the system is modular and already has fields to support different backends. Currently the only supported storage backend is dropbox, but this can easily be changed as the system is modular and already has fields to support different backends.
##Usage ## Usage
Most things should be straight forward but there are some more complicated things. Most things should be straight forward but there are some more complicated things.
###General ##### General
Create Categories and Keywords under the `New` tab. You can have a simple look at most Tables under the `List` Tab. Create Categories and Keywords under the `New` tab. You can have a simple look at most Tables under the `List` Tab.
Management options for your Data are under `Manage Data` Management options for your Data are under `Manage Data`
###Storage Backends ##### Storage Backends
Currently only dropbox is supported as a storage backend. To add a new Dropbox go to `New >> Storage Backend` and enter Currently only dropbox is supported as a storage backend. To add a new Dropbox go to `New >> Storage Backend` and enter
a name (just a display name for you to identify it) and an API access Token for the account you want to use. a name (just a display name for you to identify it) and an API access Token for the account you want to use.
You can obtain the API token on [Dropboxes API explorer](https://dropbox.github.io/dropbox-api-v2-explorer/#auth_token/from_oauth1) You can obtain the API token on [Dropboxes API explorer](https://dropbox.github.io/dropbox-api-v2-explorer/#auth_token/from_oauth1)
with the button on the top right. with the button on the top right.
###Adding Synced Path's ##### Adding Synced Path's
To add a new path from your Storage backend to the sync list, go to `Manage Data >> Configure Sync` and select the storage backend you want to use. To add a new path from your Storage backend to the sync list, go to `Manage Data >> Configure Sync` and select the storage backend you want to use.
Then enter the path you want to monitor starting at the storage root (e.g. `/Folder/RecipesFolder`) and save it. Then enter the path you want to monitor starting at the storage root (e.g. `/Folder/RecipesFolder`) and save it.
###Syncing Data ##### Syncing Data
To sync the recipes app with the storage backends press `Sync now` under `Manage Data >> Configure Sync`. To sync the recipes app with the storage backends press `Sync now` under `Manage Data >> Configure Sync`.
###Import Recipes ##### Import Recipes
All files found by the sync can be found under `List >> New Recipes`. There you can either import all at once without All files found by the sync can be found under `List >> New Recipes`. There you can either import all at once without
modifying them or import one by one, adding Category and Tags while importing. modifying them or import one by one, adding Category and Tags while importing.
###Batch Edit ##### Batch Edit
If you have many uncategorized and untagged recipes you may want to edit them all at once. For this go to If you have many uncategorized and untagged recipes you may want to edit them all at once. For this go to
`Manage Data >> Batch Edit`. Enter a word which should be contained in the recipe name and select category and tags. `Manage Data >> Batch Edit`. Enter a word which should be contained in the recipe name and select category and tags.
When clicking submit every recipe containing the word will be updated (tags are added). When clicking submit every recipe containing the word will be updated (tags are added).
> Currently the only option is word contains, maybe some more SQL like operators will be added later. > Currently the only option is word contains, maybe some more SQL like operators will be added later.
##Installation ## Installation
If you want to *install* the application for usage use a tutorial of your choice If you want to *install* the application for usage use a tutorial of your choice
(for example this one http://uwsgi-docs.readthedocs.io/en/latest/tutorials/Django_and_nginx.html) (for example this one http://uwsgi-docs.readthedocs.io/en/latest/tutorials/Django_and_nginx.html)
on deploying django applications. on deploying django applications.
@ -40,9 +40,9 @@ To start developing:
5. Run migrations with `manage.py migrate` 5. Run migrations with `manage.py migrate`
6. Start development server with `manage.py runserver` 6. Start development server with `manage.py runserver`
##Contributing ## Contributing
Pull Requests and ideas are welcome, feel free to contribute in any way. Pull Requests and ideas are welcome, feel free to contribute in any way.
##License ## License
This project is licensed under the MIT license. Even though it is not required to publish derivatives i highly encourage This project is licensed under the MIT license. Even though it is not required to publish derivatives i highly encourage
pushing changes upstream and letting people profit from any work done on this project. pushing changes upstream and letting people profit from any work done on this project.