{"id":24505842,"url":"https://github.com/michaeltelford/lucky_api_reference_project","last_synced_at":"2026-06-23T16:32:30.927Z","repository":{"id":85502223,"uuid":"311116181","full_name":"michaeltelford/lucky_api_reference_project","owner":"michaeltelford","description":"A reference project for building JSON API's with Crystal and the Lucky framework","archived":false,"fork":false,"pushed_at":"2021-01-14T20:08:57.000Z","size":46,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-31T02:51:18.396Z","etag":null,"topics":["crystal","json-api","lucky"],"latest_commit_sha":null,"homepage":"https://luckyframework.org/","language":"Crystal","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/michaeltelford.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2020-11-08T17:25:10.000Z","updated_at":"2025-02-13T07:08:59.000Z","dependencies_parsed_at":"2023-03-03T14:00:29.752Z","dependency_job_id":null,"html_url":"https://github.com/michaeltelford/lucky_api_reference_project","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/michaeltelford/lucky_api_reference_project","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaeltelford%2Flucky_api_reference_project","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaeltelford%2Flucky_api_reference_project/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaeltelford%2Flucky_api_reference_project/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaeltelford%2Flucky_api_reference_project/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/michaeltelford","download_url":"https://codeload.github.com/michaeltelford/lucky_api_reference_project/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaeltelford%2Flucky_api_reference_project/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34698687,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-23T02:00:07.161Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["crystal","json-api","lucky"],"created_at":"2025-01-21T23:31:59.828Z","updated_at":"2026-06-23T16:32:30.907Z","avatar_url":"https://github.com/michaeltelford.png","language":"Crystal","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Lucky API Reference Project\n\nThis is a HTTP JSON API written using [Lucky](https://luckyframework.org) and the [Crystal](https://crystal-lang.org/) programming language. It acts as a place of reference to build similar API's that can be consumed by front end applications.\n\n## Rationale\n\nBelow are some of the main criteria needed for a stable means of producing JSON API's:\n\n- Blazing performance\n- Low memory consumption\n- Small final Docker images\n- Fast \"cold boot\" startup times\n- Productive development:\n  - Excellent request validation\n  - Excellent JSON response serialisation support\n  - DB ORM \u0026 migrations\n  - Easily tested\n- Secure out of the box\n- Support for Many-to-Many DB connections e.g. A single API can connect to serveral DB instances and a single DB instance can have several API's connect to it\n\n**Lucky, Crystal and Docker combined tick all of the boxes!**\n\n## Setup\n\n1. [Install required dependencies](https://luckyframework.org/guides/getting-started/installing#install-required-dependencies)\n2. Update database settings in `config/database.cr`\n3. Run `script/setup`\n4. Run `lucky dev` to start the app locally at: `http://127.0.0.1:5000`\n5. Use the header `Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxfQ.W2mTap2sSGwXHjgUxLy3ruku57djep3yu5ho7ZYS4fQ` for authenticated requests with a sample user during development.\n\n## Docker\n\nCrystal compiles this entire project down to a static binary which is then copied to an Alpine Linux Docker image for production. The image weights in at `~25MB` and starts almost instantly from a cold boot; perfect for deploying to a K8s cluster or to a \"scale to zero\" cloud platform e.g. Google's Cloud Run. Check out the included Docker tasks and `Dockerfile` for details.\n\n## Learning Lucky\n\nLucky uses the [Crystal](https://crystal-lang.org) programming language. You can learn about Lucky from the [Lucky Guides](https://luckyframework.org/guides/getting-started/why-lucky).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaeltelford%2Flucky_api_reference_project","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichaeltelford%2Flucky_api_reference_project","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaeltelford%2Flucky_api_reference_project/lists"}