{"id":19265268,"url":"https://github.com/biocross/librarian","last_synced_at":"2025-04-21T19:31:24.228Z","repository":{"id":32684266,"uuid":"135885941","full_name":"biocross/Librarian","owner":"biocross","description":"Easily host your iOS and Android builds locally!","archived":false,"fork":false,"pushed_at":"2022-12-07T19:13:21.000Z","size":26344,"stargazers_count":36,"open_issues_count":9,"forks_count":6,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-15T14:42:43.495Z","etag":null,"topics":["android","deployment","ios","local"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/biocross.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}},"created_at":"2018-06-03T08:15:52.000Z","updated_at":"2023-02-26T17:48:22.000Z","dependencies_parsed_at":"2023-01-14T21:55:34.713Z","dependency_job_id":null,"html_url":"https://github.com/biocross/Librarian","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/biocross%2FLibrarian","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/biocross%2FLibrarian/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/biocross%2FLibrarian/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/biocross%2FLibrarian/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/biocross","download_url":"https://codeload.github.com/biocross/Librarian/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250119870,"owners_count":21378103,"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":["android","deployment","ios","local"],"created_at":"2024-11-09T19:45:21.772Z","updated_at":"2025-04-21T19:31:23.801Z","avatar_url":"https://github.com/biocross.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\u003cdiv align=\"center\"\u003e\n\u003cimg width=\"500\" src=\"https://raw.githubusercontent.com/biocross/Librarian-Web/master/assets/LogoText_medium.png\" alt=\"Librarian\"\u003e\u003cbr/\u003e\u003cbr/\u003e\n\u003c/div\u003e\n\n\n\u003e Librarian is an easy way to serve your iOS \u0026 Android builds on your local network, and make testing internal versions of your app effortless.\n \n[![NPM Version](http://img.shields.io/npm/v/librarian-server.svg?style=flat)](https://www.npmjs.org/package/librarian-server)\n\n\u003cimg width=\"250\" src=\"https://raw.githubusercontent.com/biocross/librarian/master/demo.gif\" alt=\"Librarian on iOS\"\u003e\u003cbr/\u003e\u003cbr/\u003e\n\n## Highlights\n\n- [x] Support for iOS `IPA` \u0026 Android `APK`\n- [x] Simple \u0026 Quick Setup\n- [x] Clean Web Interface\n- [x] Easily add builds\n- [x] Ability to have Internet accessible Public URLs for builds\n- [x] Instant app installs on the local network, your testers don't have to wait!\n- [x] No more dependency on `Crashlytics Beta` / `Testflight`\n\n## Install\n\n```console\n$ sudo npm i -g librarian-server\n$ librarian setup\n$ sudo npm link librarian-server # If you can get an `EACCESS / Permissions` error\n```\n\nThe setup will ask you a few questions to configure Librarian on your system. You can just press enter throughout the process to choose the default values.\n\n## Usage\n\n### Starting Librarian\n\nRun the following command to start the Librarian server.  \n\n```console\n$ librarian start\n```\nThis will start the web interface, and will print the URL to it on the console, along with a QR code to the URL for quick access 😁\n\n\u003e Librarian uses [ngrok](https://ngrok.com/product) tunneling to serve your localhost over the Internet using a secure `HTTPS` tunnel. Also, `HTTPS` is mandatory for iOS Builds to work.\n\n### Submitting Builds\n\nSubmit builds to Librarian using:\n\n```console\n$ librarian submit \u003cpathToFile\u003e [options]\n```\nThe `pathToFile` must be the full path to the `IPA` or `APK` file. Example: `/Users/jenkins/MyApp.ipa`, and should be accessible by Librarian.\n\nYou can pass in the following additional options along with the path of the build file.\n\nOption | Short | Example | Description\n--- | --- | --- | ---\n`--branch \u003cbranch\u003e` | `-b` | `--branch master` | git branch the build is from\n`--notes \u003cnotes\u003e` | `-n` | `--notes \"Release Candidate Build\"` | release notes for the build\n`--public` | `-p` | Just add the flag `--public` | allow the build to be downloaded over the HTTPs tunnel (by default, builds can only be downloaded on the local network)\n\nLibrarian will autodetect the type of build `iOS / Android` using the file extension, will create a copy of the build in it's assets, and make it available for download on it's web interface.\n\n\u003e The Librarian server should be running while submitting a build.\n\n## Updating Librarian\n\nLibrarian follows [semantic versioning](https://semver.org/). You can update by running:\n\n```console\n$ npm i -g librarian-server\n$ librarian update\n```\n\n## Contributing\n\nLibrarian is built up of two parts:\n\n- [Librarian](https://github.com/biocross/Librarian) - The Command Line tool, written in NodeJS (this repository).\n- [Librarian Web](https://github.com/biocross/Librarian-Web) - The Web Interface of Librarian, built in Jekyll.\n\n\n## Maintainers\n\nDeveloped by [biocross](https://twitter.com/sids7) \u0026 designed by [madebytushar](https://twitter.com/madebytushar)\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbiocross%2Flibrarian","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbiocross%2Flibrarian","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbiocross%2Flibrarian/lists"}