{"id":28260022,"url":"https://github.com/ldgrp/snails-api","last_synced_at":"2025-07-29T11:07:24.430Z","repository":{"id":166037715,"uuid":"289001029","full_name":"ldgrp/snails-api","owner":"ldgrp","description":"servant-server + persistent implementation of an accidental twitter+messenger clone.","archived":false,"fork":false,"pushed_at":"2020-09-29T13:49:36.000Z","size":30,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-17T22:39:25.564Z","etag":null,"topics":["haskell","persistent","servant"],"latest_commit_sha":null,"homepage":"","language":"Haskell","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/ldgrp.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,"zenodo":null}},"created_at":"2020-08-20T12:32:13.000Z","updated_at":"2020-09-29T13:49:38.000Z","dependencies_parsed_at":null,"dependency_job_id":"54ccb0de-f1ba-4098-a88f-daa544c2a261","html_url":"https://github.com/ldgrp/snails-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ldgrp/snails-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ldgrp%2Fsnails-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ldgrp%2Fsnails-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ldgrp%2Fsnails-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ldgrp%2Fsnails-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ldgrp","download_url":"https://codeload.github.com/ldgrp/snails-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ldgrp%2Fsnails-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267677114,"owners_count":24126309,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"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":["haskell","persistent","servant"],"created_at":"2025-05-20T04:08:55.781Z","updated_at":"2025-07-29T11:07:24.417Z","avatar_url":"https://github.com/ldgrp.png","language":"Haskell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🐌 Snails (Test) Server \u0026 API\n\n~~Generates a Swagger spec from a Servant API.~~\n\nThis program will\n\n- Start a [warp][warp] server on port 8081\n- Initialize a SQLite database file at `./db.sqlite`\n- Populate the SQLite database (see Main.hs)\n- Serve the Snails REST API\n- Generate Swagger docs\n\n## ⚡ Viewing the spec\n\nUse [Swagger Editor][swagger-editor] to view `swagger.json`.\n\n\n## 🚀 Usage\n\nThis project was built with [Servant][servant] + [Persistent][persistent].\n\nIf you do not have `cabal`, I highly recommend [`ghcup`][ghcup] or \nreading [this manual][cabal].\n\n```bash\n# Clone this repo\ngit clone https://github.com/ldgrp/snails-api\n\n# Navigate to project directory\ncd snails-api\n\n# Start the server\ncabal run\n```\n\n\n## 💻 Development\n\n1. Clone this repo `git clone https://github.com/ldgrp/snails-api`\n2. Edit the files in `src/`.\n3. Run the main executable with `cabal run` in the main directory.\n   This will generate a `swagger.json`.\n\n## 🗒️ Todo\n\n- [ ] Authentication\n- [ ] Handle JWT tokens. For protected endpoints, the server will currently accept\n      the user id as a \"token\".\n- [x] User API\n- [x] Entry API\n- [x] Messaging API\n- [x] (Mock) Map API\n- [x] (Mock) News API\n- [x] (Mock) Transport API\n- [x] (Mock) Weather API\n- [ ] Use esqueleto. Persistent does _not_ support SQL joins 😞\n- [ ] Postgres support\n- [ ] Tests\n\n[persistent]:https://www.yesodweb.com/book/persistent\n[servant]: https://www.servant.dev/\n[swagger-editor]: https://editor.swagger.io?url=https://raw.githubusercontent.com/ldgrp/snails-api/master/swagger.json\n[ghcup]: https://www.haskell.org/ghcup/\n[cabal]: https://www.haskell.org/cabal/\n[warp]: https://hackage.haskell.org/package/warp","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fldgrp%2Fsnails-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fldgrp%2Fsnails-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fldgrp%2Fsnails-api/lists"}