{"id":13409905,"url":"https://github.com/opensubsonic/open-subsonic-api","last_synced_at":"2025-03-14T15:31:05.002Z","repository":{"id":152069189,"uuid":"603683317","full_name":"opensubsonic/open-subsonic-api","owner":"opensubsonic","description":"Repository hosting the definition and discussions of the Open Subsonic API","archived":false,"fork":false,"pushed_at":"2024-10-25T15:12:50.000Z","size":1209,"stargazers_count":83,"open_issues_count":5,"forks_count":7,"subscribers_count":17,"default_branch":"main","last_synced_at":"2024-10-25T18:29:08.728Z","etag":null,"topics":["api","opensubsonic","subsonic"],"latest_commit_sha":null,"homepage":"https://opensubsonic.netlify.app/","language":"HTML","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/opensubsonic.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2023-02-19T09:06:24.000Z","updated_at":"2024-10-25T15:12:52.000Z","dependencies_parsed_at":"2023-11-25T02:28:45.938Z","dependency_job_id":"ab84d25b-7567-4130-b327-4ea0fae871fc","html_url":"https://github.com/opensubsonic/open-subsonic-api","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/opensubsonic%2Fopen-subsonic-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensubsonic%2Fopen-subsonic-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensubsonic%2Fopen-subsonic-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensubsonic%2Fopen-subsonic-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opensubsonic","download_url":"https://codeload.github.com/opensubsonic/open-subsonic-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243600560,"owners_count":20317299,"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":["api","opensubsonic","subsonic"],"created_at":"2024-07-30T20:01:03.977Z","updated_at":"2025-03-14T15:31:04.627Z","avatar_url":"https://github.com/opensubsonic.png","language":"HTML","funding_links":[],"categories":["SCSS"],"sub_categories":[],"readme":"# OpenSubsonic Website\n\n[![Netlify Status](https://api.netlify.com/api/v1/badges/55c14fbc-7240-4dc0-9092-3cd442400473/deploy-status)](https://app.netlify.com/sites/opensubsonic/deploys)\n\nThis is the source code for the OpenSubsonic documentation website. It is built with [Hugo](https://gohugo.io) and the [Docsy][] theme. \n\nYou can find detailed theme instructions in the [Docsy user guide][].\n\n## Running in a container locally\n\nYou can run this project inside a [Docker](https://docs.docker.com/)\ncontainer, the container runs with a volume bound to the project's source\nfolder. This approach doesn't require you to install any dependencies other\nthan [Docker Desktop](https://www.docker.com/products/docker-desktop) on\nWindows and Mac, and [Docker Compose](https://docs.docker.com/compose/install/)\non Linux.\n\n1. Build the docker image\n\n   ```bash\n   docker-compose build\n   ```\n\n1. Run the built image\n\n   ```bash\n   docker-compose up\n   ```\n\n   \u003e NOTE: You can run both commands at once with `docker-compose up --build`.\n\n1. Verify that the service is working.\n\n   Open your web browser and type `http://localhost:1313` in your navigation bar,\n   This opens a local instance of the project's homepage. You can now make\n   changes to the source code and those changes will immediately show up in your\n   browser after you save.\n\n### Cleanup\n\nTo stop Docker Compose, on your terminal window, press **Ctrl + C**.\n\nTo remove the produced images run:\n\n```bash\ndocker-compose rm\n```\nFor more information see the [Docker Compose\ndocumentation](https://docs.docker.com/compose/gettingstarted/).\n\n## Setting up the development environment\n\n1. Install dependencies:\n   - [Go][]\n   - [Hugo][]\n   - [Node.js][]\n2. Clone this repository\n   ```bash\n   git clone https://github.com/deluan/open-subsonic-api\n   cd open-subsonic-api\n   ```\n3. If you want to do SCSS edits and want to publish these, you need to install `PostCSS`\n   ```bash\n   npm install\n   ```\n\n### Running the website locally\n\nBuilding and running the site locally requires a recent `extended` version of [Hugo](https://gohugo.io).\nYou can find out more about how to install Hugo for your environment in our\n[Getting started](https://www.docsy.dev/docs/getting-started/#prerequisites-and-installation) guide.\n\nOnce you've made your working copy of the site repo, from the repo root folder, run:\n\n```bash\nhugo server\n```\n\n### Troubleshooting\n\nAs you run the website locally, you may run into the following error:\n\n```\n➜ hugo server\n\nINFO 2021/01/21 21:07:55 Using config file: \nBuilding sites … INFO 2021/01/21 21:07:55 syncing static files to /\nBuilt in 288 ms\nError: Error building site: TOCSS: failed to transform \"scss/main.scss\" (text/x-scss): resource \"scss/scss/main.scss_9fadf33d895a46083cdd64396b57ef68\" not found in file cache\n```\n\nThis error occurs if you have not installed the extended version of Hugo.\nSee this [section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-hugo) of the user guide for instructions on how to install Hugo.\n\nOr you may encounter the following error:\n\n```\n➜ hugo server\n\nError: failed to download modules: binary with name \"go\" not found\n```\n\nThis error occurs if you have not installed the `go` programming language on your system.\nSee this [section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-go-language) of the user guide for instructions on how to install `go`.\n\n\n[Go]: https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-go-language\n[Hugo]: https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-hugo\n[Node.js]: https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#installupgrade-nodejs\n[Docsy user guide]: https://docsy.dev/docs\n[Docsy]: https://docsy.dev\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopensubsonic%2Fopen-subsonic-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopensubsonic%2Fopen-subsonic-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopensubsonic%2Fopen-subsonic-api/lists"}