{"id":17142362,"url":"https://github.com/odiroot/jiaoge","last_synced_at":"2026-01-18T11:42:46.745Z","repository":{"id":39138876,"uuid":"197256103","full_name":"odiroot/jiaoge","owner":"odiroot","description":"Keeping track of postcards if you're into it","archived":false,"fork":false,"pushed_at":"2023-08-14T04:25:02.000Z","size":185,"stargazers_count":2,"open_issues_count":5,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-06T03:41:17.033Z","etag":null,"topics":["django","heroku","postcard","postgresql","s3","travel"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/odiroot.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-07-16T19:34:03.000Z","updated_at":"2022-01-03T15:10:14.000Z","dependencies_parsed_at":"2024-10-14T20:30:52.050Z","dependency_job_id":"57017815-c984-442b-97d6-8c57fb7785aa","html_url":"https://github.com/odiroot/jiaoge","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/odiroot/jiaoge","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/odiroot%2Fjiaoge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/odiroot%2Fjiaoge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/odiroot%2Fjiaoge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/odiroot%2Fjiaoge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/odiroot","download_url":"https://codeload.github.com/odiroot/jiaoge/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/odiroot%2Fjiaoge/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28535177,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T10:13:46.436Z","status":"ssl_error","status_checked_at":"2026-01-18T10:13:11.045Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["django","heroku","postcard","postgresql","s3","travel"],"created_at":"2024-10-14T20:30:43.879Z","updated_at":"2026-01-18T11:42:46.713Z","avatar_url":"https://github.com/odiroot.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# jiaoge\n_Keeping track of postcards if you're into it_\n\n![https://www.flickr.com/photos/postmark_china/7751502180/](./postcard.jpg)\n\n\n# Quickstart\n\n## Requirements\n\n* _Heroku_ account (free tier is good as well).\n* _Amazon Web Services_ account (free tier works here too).\n    * _S3_ bucket, not exposed to the public by default.\n    * _IAM_ credentials for non-root user.\n\n## Setup\n\n1. Create a new application on Heroku, use the newest stack (`heroku-18`).\n2. Add _Heroku Postgres_ add-on (_Hobby Dev_ suffices).\n3. Add _Sentry_ add-on if you want to track errors.\n4. Add `heroku/python` buildpack.\n5. Add `heroku-community/apt` buildpack.\n6. Connect your (clone of this one) _Github_ repository to your Heroku app.\n7. Set the _Config Vars_.\n    * `ADMIN_URL` -- generate some hard to guess string in a form of `foo/`.\n    * `AWS_ACCESS_KEY_ID` / `AWS_SECRET_ACCESS_KEY` -- your IAM credentials.\n    * `AWS_STORAGE_BUCKET_NAME` -- name of your S3 bucket.\n    * `HASHID_FIELD_SALT` -- generate another hard to guess long string.\n    * `HEROKU_DOMAIN` -- the domain you access the app at. e.g.: `myproject.herokuapp.com`.\n\n## First run\n1. Use the _Manual deploy_ feature on Heroku to deploy `master` branch.\n2. Wait until the deployment is done.\n3. Select a _Free_ dyno tier for the `web` dyno.\n4. Enable the `web` dyno to start it.\n5. Spawn a shell session for the app: `heroku run -a \u003cyour app name\u003e bash`\n6. Push the static files to S3: `./manage.py collectstatic`.\n\n\n# Why\nI personally send a lot of postcards to my family and friends whenever I'm\ntraveling.\n\nOne day it hit me -- it would be really nice to keep track _which_ postcard\ndid I send to _whom_ from _where_. On top of that, if only I could tell\nhow long have the postcards spent in transit?\n\nI built this project as minimal, simple way to make this happen.\n\nThe whole application can be easily deployed on free _Heroku_ tier.\nIt relies on PostgreSQL instance being running and attached to the app.\n\n# What\nThis is a very basic Django-based web application with barely any front-end\ncode, mostly leveraging the awesome Django Admin system.\n\n_Normalize_ and _Milligram_ CSS framework are used to make the few\nserver-rendered views to look semi-decent on both desktop and mobile devices.\n\nThere's absolutely no JavaScript code involved.\n\n# How\nOne can use the admin pages to create a simple \"address book\" (actually more\nof a _rolodex_ as I wanted to avoid storing addresses) of friends and family\nmembers.\n\nAs a second step it's possible to create records for the postcards to be sent\nfrom one's travels. A card record is very rudimentary and consists of\nthe postcard source (where was it posted), destination (selected contact\nfrom the address book) and dispatch date.\n\nAn extra feature allows user to upload a picture of the postcard to be attached\nto the card record.\n\nIn a basic form the application user can also edit the card records to append\nthe information about the time of postcard reception.\n\n# Bonus: interactivity\nThe cherry on top is the ability for the postcard receivers to confirm\ntheir arrival (claim the card).\n\nThere's a card claim view: `/claim/\u003cCODE\u003e` that can be used by the addressee\nto let the sender know about the reception with a single press of a button.\nNaturally, this relies on your friends/family being bothered enough to actually\nopen the claiming URL.\n\nYou can write/print the URL on your postcards to let the addressees enter\nthe claim page. I personally use _TinyURL_ to shorten the long Heroku address.\n\nI also researched and opted for standard-format (48.5mm × 16.9mm) stickers\nwith pre-printed shortened claim URL, to which I add (by hand) the card\nclaim code (generated by the great _hashids_ library).\nEvery postcard has an unique claim address and can only be claimed once\n(naturally). Finally I let the received give me a comment/feedback before\nclicking the button.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fodiroot%2Fjiaoge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fodiroot%2Fjiaoge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fodiroot%2Fjiaoge/lists"}