Skip to content

Greenvahn/food-oracle

Repository files navigation

🍜 food-oracle

A simple meal planner using Trello boards with recipes.

This project is still under developent.

🎢 Build Setup

Requires node 16x

# install dependencies
$ yarn install

# serve with hot reload at localhost:3000
$ yarn dev

# build for production and launch server
$ yarn build
$ yarn start

# generate static project
$ yarn generate

For detailed explanation on how things work with Nuxt.js (Vue), check out the documentation.


🌠 Trello Boards - Setup

This app uses the Trello API to fecth information directly from the trello boards with recipes.In order to connect any board with this app you will need:

  • A trello user API.
    • * You will need to be registered and logged in Trello in order to get one.
  • A trello board ID.
    • It is visible as part of the any board URL

Optional parameters:

  • A trello authentication token.

    • This only applies to private boards.
  • Excluding cards by name.

    • This is totally optional. Remove it from your .env if not in use.

After the intial installation, you will find an .env.sample file at the root project folder. Rename it to .env

.env

TR_USER_API_KEY = yourTrelloAPIgoeshere
TR_PRIVATE_AUTH_TOKEN = privateBoardToken
TR_BOARD_ID = boardID
TR_EXCLUDING_CARD = exludingKeyword

⚠️ The TR_AUTH_TOKEN is only required if the board is private!

🎯 The TR_EXCLUDING_CARD is used to filter out cards by title keywords. This is optional!


🥑 Private Trello Boards

An user authorization is required from the trello board's owner if you are accessing a private board.

Request a token granting read-only access forever :

https://trello.com/1/authorize?key=substitutewithyourapplicationkey&name=My+Application&expiration=never&response_type=token

Trello API documentation

Please refer to http://www.trello.org/help.html to know how to get an API KEY for development between other things.

About

Meal planner built with Vue and boosted by Trello boards

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published