{"id":24914188,"url":"https://github.com/rasjonell/x-library","last_synced_at":"2025-03-28T05:22:40.522Z","repository":{"id":50663477,"uuid":"519546747","full_name":"rasjonell/x-library","owner":"rasjonell","description":"Self-Hosted, Open, and Editable Library Management Platform","archived":false,"fork":false,"pushed_at":"2023-09-13T20:51:03.000Z","size":3200,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-02T06:16:40.549Z","etag":null,"topics":["elixir","goodreads","library","phoenix","phoenix-framework","rest-api"],"latest_commit_sha":null,"homepage":"https://rasjonell.github.io/x-library/","language":"Elixir","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/rasjonell.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}},"created_at":"2022-07-30T15:03:41.000Z","updated_at":"2022-08-07T16:30:23.000Z","dependencies_parsed_at":"2022-09-09T10:40:26.520Z","dependency_job_id":null,"html_url":"https://github.com/rasjonell/x-library","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rasjonell%2Fx-library","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rasjonell%2Fx-library/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rasjonell%2Fx-library/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rasjonell%2Fx-library/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rasjonell","download_url":"https://codeload.github.com/rasjonell/x-library/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245974241,"owners_count":20702994,"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","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":["elixir","goodreads","library","phoenix","phoenix-framework","rest-api"],"created_at":"2025-02-02T06:16:43.511Z","updated_at":"2025-03-28T05:22:40.490Z","avatar_url":"https://github.com/rasjonell.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# X Library\n\nSelf-Hosted, Open, and Editable Library Management Platform \n\n![Banner Photo](./x-library.png)\n\n_Check out the cross-platform mobile client for this API: [X-Library Mobile](https://github.com/rasjonell/x-library-mobile)_\n\n# Ideas To Implement Next\n\n- [ ] Federated Network of Book Reviews/Recommendations\n  - Ability for peers to sync with other peers\n  - Social networking capabilities(follow users from other instances(ActivityPub?))\n\n- [ ] RSS Feed for reviews\n  - Use ISBN database services to link the book inside the review to an external source\n\n- [ ] Statistics\n  - GoodReads style statistics for both books and users\n\n- [x] Add books from an external source\n  - use OpenLibrary or a similar service to fetch books with the ISBN number\n\n# Note for Clients\n\nThe API now allows book creation/addition with only the ISBN number, thus, the [OpenLibrary API](https://openlibrary.org/developers/api) can be leveraged  in your client to search for books, authors, genres, etc. Then use the retrieved ISBN to add the book to the X Library platform.\n\n# Development\n\n## Setup\n\nTo start your Phoenix server:\n  * Update `dev.exs` config with your database credentials\n  * Rename `dev.example_secrets.exs` to `dev.secrets.exs` and follow the examples to setup the authentication secrets.\n  * Install dependencies with `mix deps.get`\n  * Create, migrate, and seed your database with `mix ecto.setup`\n  * Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`\n\n## Usage\n\nCheck out the OpenAPI Docs Website: https://rasjonell.github.io/x-library/\n\nOr jump to [API Usage Docs](#api-usage-docs)\n\nYou can [download](https://raw.githubusercontent.com/rasjonell/x-library/main/x-library-api-spec.yaml) the OpenApi spec and import it in Insomnia or Postman and get a testable API.\n\n### Importing OpenAPI specs into your favorite API platform.\n\n- Postman: [Working With OpenAPI](https://learning.postman.com/docs/integrations/available-integrations/working-with-openAPI/)\n- Insomnia:\n  - Open up Insomnia\n  - Navigate to Dashboard\n  - Click `Create`\n  - Choose `URL`\n  - Paste this URL: `https://raw.githubusercontent.com/rasjonell/x-library/main/x-library-api-spec.yaml`\n  - Answer the prompts to create a new Design Document\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frasjonell%2Fx-library","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frasjonell%2Fx-library","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frasjonell%2Fx-library/lists"}