{"id":16068322,"url":"https://github.com/mssola/operum","last_synced_at":"2025-04-11T04:37:14.370Z","repository":{"id":227636312,"uuid":"771636800","full_name":"mssola/operum","owner":"mssola","description":"Simple application that keeps track of all your sources (i.e. books, papers, articles).","archived":false,"fork":false,"pushed_at":"2025-01-27T21:02:48.000Z","size":294,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-11T04:37:11.100Z","etag":null,"topics":["bibliography","rails","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mssola.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","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":"2024-03-13T17:03:13.000Z","updated_at":"2025-01-27T21:02:52.000Z","dependencies_parsed_at":"2024-06-10T05:25:36.937Z","dependency_job_id":"7929b041-dab8-4505-8cca-c8d27f9e0179","html_url":"https://github.com/mssola/operum","commit_stats":{"total_commits":57,"total_committers":2,"mean_commits":28.5,"dds":"0.29824561403508776","last_synced_commit":"92716febd87c105fc74bb26f8d45383b8b81d609"},"previous_names":["mssola/operum"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mssola%2Foperum","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mssola%2Foperum/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mssola%2Foperum/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mssola%2Foperum/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mssola","download_url":"https://codeload.github.com/mssola/operum/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248345256,"owners_count":21088231,"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":["bibliography","rails","ruby"],"created_at":"2024-10-09T06:20:46.454Z","updated_at":"2025-04-11T04:37:14.350Z","avatar_url":"https://github.com/mssola.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e mille dea est operum: certe dea carminis illa est; \u003cbr /\u003e\n\u003e \u0026emsp; si mereor, studiis adsit amica meis.\n\u003e\n\u003e \u0026mdash; P. Ovidi Nasonis - Fasti 3.833-834\n\nThis is a simple application that keeps track of all your sources (i.e. books,\npapers, articles). With this information at hand you can:\n\n- Add comments and notes to any source to keep track of what you found more\n  relevant from it.\n- Tag sources and comments in whatever way you wish.\n- Save searches that match on a user-defined tag, or a certain string from any\n  of your sources or comments.\n- Export searches into CSV or TeX so it can be used for building up bibliography\n  sections on a paper you might be working on.\n\n## Workflow\n\nThe workflow revolves around the idea of being able to track sources and\ncomments with tags that you have defined, and then being able to list sources\nwith searches based on these tags. This way, you might want to add tags about\nproject names, topics, language, etc.; and then attach these tags into the\nsources and comments that you have added into the application. Afterwards, you\ncan save searches and they will be shown on top of the application. With this,\nyou can switch between different ways in which you have groupped your sources.\nThis groups come in handy to further filter on your sources, or to export these\nsources into a TeX file that can be used for the paper you might be working on.\n\n## Deployment\n\nThe recommended way to deploy this application is through a Docker container.\nTake a look at the provided `Dockerfile` file, which is more than enough to get\nthis done. After building the image, remember that:\n\n1. You need to provide a `RAILS_MASTER_KEY`, just like any other Rails application.\n2. You need to create a Docker volume for the `/rails/storage` path. This path\n   will contain the SQLite3 database and thus you need this to persist across\n   deployments.\n\nOh, yeah, we are using SQLite3 in production, no biggie! For the use case of\nthis application SQLite3 is actually just fine and it allows us to keep things\nsimple.\n\nOther than that, there are some *optional* environment variables that you might\nwant to touch:\n\n- `OPERUM_BASE_TITLE`: the title that is going to be shown for the application.\n  By default this is set to be just `Operum`.\n- `OPERUM_DEFAULT_LOCALE`: that's right, this application supports multiple\n  languages! For now these languages are catalan and english but other languages\n  are also welcome, just hit me with a\n  [PR](https://github.com/mssola/operum/pulls) and take a look at the files\n  under `config/locales`. You can change the default locale (catalan) by setting\n  this environment variable with the language code for it (i.e. `en` for\n  english).\n\n## Contributing\n\nDo you want to contribute with code, or to report an issue you are facing? Read\nthe [CONTRIBUTING.md](./CONTRIBUTING.md) file.\n\n## [Changelog](https://pbs.twimg.com/media/DJDYCcLXcAA_eIo?format=jpg\u0026name=small)\n\nRead the [CHANGELOG.md](./CHANGELOG.md) file.\n\n## License\n\n```txt\nCopyright (C) 2023-Ω Miquel Sabaté Solà \u003cmikisabate@gmail.com\u003e\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU Affero General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU Affero General Public License for more details.\n\nYou should have received a copy of the GNU Affero General Public License\nalong with this program.  If not, see \u003chttps://www.gnu.org/licenses/\u003e.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmssola%2Foperum","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmssola%2Foperum","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmssola%2Foperum/lists"}