https://github.com/chicks-net/heroku-groceries
shared grocery list to run in Heroku
https://github.com/chicks-net/heroku-groceries
Last synced: 3 months ago
JSON representation
shared grocery list to run in Heroku
- Host: GitHub
- URL: https://github.com/chicks-net/heroku-groceries
- Owner: chicks-net
- License: gpl-2.0
- Created: 2015-10-05T17:06:31.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-10-05T18:27:58.000Z (over 9 years ago)
- Last Synced: 2025-01-25T20:44:03.823Z (4 months ago)
- Size: 148 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# heroku groceries
shared grocery list to run in Heroku
## purpose
We are just trying to learn more python and databases so
don't expect to run millions of grocery lists with this code.
## data model
*family* contains *list* which contain *item*
* family
* contains *list*
* has attributes
* email addresses
* list
* contains *item*
* has attributes
* name
* item
* has attributes
* name
* quantity
## REST API
as yet undefined:
* adding items to lists
* marking items off of lists
* creating lists
* deleting lists
### GET /lists
Return the lists that you currently have access to.
#### URL
`/lists.json`
#### endpoint metadata
| item | details |
| ------- | ------- |
| Response formats | JSON |
| Requires authentication? | Not yet! |
#### paramaters
none
#### example request
`/lists.json`
#### example response
TODO: fill in
### GET /items
Return the items for a given list
#### URL
`/items.json`
#### endpoint metadata
| item | details |
| ------- | ------- |
| Response formats | JSON |
| Requires authentication? | Not yet! |
#### paramaters
`list =` *listid*
Which list do you want items for?
#### example request
`/items.json?list=1234`
#### example response
TODO: fill in
### GET /db_initialize
Initialize the database
#### URL
`/db_initialize.json`
#### endpoint metadata
| item | details |
| ------- | ------- |
| Response formats | JSON |
| Requires authentication? | Not yet! Oh no! |
#### paramaters
None
#### example request
`/db_initialize.json`
#### example response
TODO: fill in