Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
arienshibani authored Feb 2, 2024
1 parent 44ac3c3 commit fa2c495
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Green Bite API 🌱
Green Bite __attempts__ to calculate sustainability scores for food. Sometimes it even works! πŸ€·β€β™‚οΈ Part of my masters thesis on ingredient matching to determine the sustainability of online recipes. (Information Science, UiB: 2020).


## How are sustainability scores calculated? πŸ’‘
Using this formula
`(amount_kg * land_usage) + (amount_kg * greenhouse_gas_emissions) = sustainability_score`
Expand All @@ -12,18 +13,21 @@ Using this formula
* **Alot** of assumptions and simplifications. Take the results with a shovel of salt. πŸ§‚

## Quickstart
* Make sure you have [Docker](https://www.docker.com/get-started) installed
* Make sure you have [Docker](https://www.docker.com/get-started) installed and that it is running.

1. `git clone git@github.com:arienshibani/green-bite.git`
1. ✨ Clone repo `git clone git@github.com:arienshibani/green-bite.git`

2. πŸ—οΈ Build image `docker build -t green-bite`
2. πŸ—οΈ Navigate into repo and build the image `docker build .`

3. πŸ‹ Run container `docker run -p 80:80 green-bite`

The API should now be available πŸ‘‰ http://0.0.0.0/docs
Open API specification should now be available locally! πŸ‘‰ http://0.0.0.0/docs

## Example Usage

![image](https://github.com/arienshibani/green-bite/assets/22197324/2df0c8f0-e957-4385-aff2-60cc5d1afa05)


GET `http://0.0.0.0/parse/ingredient/1%20kg%20of%20bacon`

Response πŸ‘‡
Expand Down

0 comments on commit fa2c495

Please sign in to comment.