{"id":26418673,"url":"https://github.com/navidrome/website","last_synced_at":"2025-10-25T02:29:10.395Z","repository":{"id":37850957,"uuid":"249322605","full_name":"navidrome/website","owner":"navidrome","description":"Navidrome's documentation website","archived":false,"fork":false,"pushed_at":"2025-03-12T00:37:03.000Z","size":59052,"stargazers_count":26,"open_issues_count":16,"forks_count":110,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-12T02:38:21.466Z","etag":null,"topics":["docs","docsy","hugo"],"latest_commit_sha":null,"homepage":"https://www.navidrome.org","language":"JavaScript","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/navidrome.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-23T03:01:51.000Z","updated_at":"2025-03-12T00:37:07.000Z","dependencies_parsed_at":"2023-02-18T22:00:40.063Z","dependency_job_id":"51538b0d-2213-4f1c-8f10-c6689fac224d","html_url":"https://github.com/navidrome/website","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/navidrome%2Fwebsite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/navidrome%2Fwebsite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/navidrome%2Fwebsite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/navidrome%2Fwebsite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/navidrome","download_url":"https://codeload.github.com/navidrome/website/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247980837,"owners_count":21027808,"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":["docs","docsy","hugo"],"created_at":"2025-03-18T01:54:20.321Z","updated_at":"2025-10-25T02:29:10.308Z","avatar_url":"https://github.com/navidrome.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Navidrome Website\n\n![Netlify Status](https://api.netlify.com/api/v1/badges/fc69beaf-8f79-41a0-9032-5dc4e9221acf/deploy-status)\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\n2. 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\n3. 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 local environment\n\n1. Install dependencies:\n    - [Go][]\n    - [Hugo][] (0.107.0 or newer)\n    - [Node.js][]\n   \n   ### Linux\n   #### Debian-based distributions (e.g., Ubuntu)\n   ```bash\n   # Install Go\n   sudo apt update\n   sudo apt install golang-go\n\n   # Install Hugo\n   sudo apt install hugo\n\n   # Install Node.js\n   sudo apt install nodejs npm\n   ```\n\n   #### Arch Linux\n   ```bash\n   # Install Go\n   sudo pacman -S go\n\n   # Install Hugo\n   sudo pacman -S hugo\n\n   # Install Node.js\n   sudo pacman -S nodejs npm\n   ```\n\n   ### macOS\n   ```bash\n   # Install Homebrew if not already installed\n   /bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)\"\n\n   # Install Go\n   brew install go\n\n   # Install Hugo (extended version)\n   brew install hugo\n\n   # Install Node.js\n   brew install node\n   ```\n\n   ### Windows\n   ```powershell\n   # Install Chocolatey (if not already installed)\n   Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))\n\n   # Install Go\n   choco install golang\n\n   # Install Hugo (extended version)\n   choco install hugo-extended\n\n   # Install Node.js\n   choco install nodejs\n   ```\n\n2. Clone this repository:\n   ```bash\n   git clone https://github.com/navidrome/website\n   cd website\n   ```\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\u003e NOTE: For Windows users, be sure to install the extended edition of Hugo via `choco install hugo-extended`.\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\nThis will start Hugo and serve the site at [http://localhost:1313](http://localhost:1313).\n\n## Credits\n\nPhotos from Unsplash by:\n* [Travis Yewell](https://unsplash.com/@shutters_guild?utm_source=unsplash\u0026amp;utm_medium=referral\u0026amp;utm_content=creditCopyText)\n* [Florencia Viadana](https://unsplash.com/@florenciaviadana?utm_source=unsplash\u0026amp;utm_medium=referral\u0026amp;utm_content=creditCopyText\")\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\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnavidrome%2Fwebsite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnavidrome%2Fwebsite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnavidrome%2Fwebsite/lists"}