{"id":22120156,"url":"https://github.com/maxpleaner/musicker","last_synced_at":"2025-03-24T06:26:34.986Z","repository":{"id":84577100,"uuid":"67261770","full_name":"MaxPleaner/musicker","owner":"MaxPleaner","description":"website for music sampling (front-end component, work in progress)","archived":false,"fork":false,"pushed_at":"2016-09-07T01:49:09.000Z","size":75,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-29T12:14:50.266Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/MaxPleaner.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-09-02T23:56:11.000Z","updated_at":"2016-09-05T21:05:05.000Z","dependencies_parsed_at":"2023-03-12T23:42:48.004Z","dependency_job_id":null,"html_url":"https://github.com/MaxPleaner/musicker","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/MaxPleaner%2Fmusicker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaxPleaner%2Fmusicker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaxPleaner%2Fmusicker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaxPleaner%2Fmusicker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MaxPleaner","download_url":"https://codeload.github.com/MaxPleaner/musicker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245220030,"owners_count":20579689,"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":[],"created_at":"2024-12-01T14:21:10.252Z","updated_at":"2025-03-24T06:26:34.953Z","avatar_url":"https://github.com/MaxPleaner.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Static Website Skeleton\n\nThis is a skeleton for static websites.\n\nThere are four main components:\n\n  - the `gen.rb` file, which handles compilation\n  - the `Guardfile`, which watches files for changes and re-compiles.\n  - an extremely simple static server, `webrick.rb`\n  - a `push_dist_to_gh_pages` script which will deploy the generated site\n\n---\n\n## About gen.rb (compilation step)\n\n  - `gen.rb` is set up to convert `coffee`, `sass`, and `slim` files into their respective `js`, `css`, and `html`.\n  - `gen.rb` looks for source files _anywhere in the tree except for `dist/`_\n  - all `slim` files are compiled into `dist/\u003cNAME\u003e.html` files\n  - all `sass` files are compiled into `dist/styles/\u003cNAME\u003e.css` files. Source files with a `.css` extension are also moved here.\n  - all `coffee` files are compiled into `dist/scripts/\u003cNAME\u003e.js` files. Source files with a `.js` extension are also moved here.\n\nThere is custom implementation for template partials.\nIn a `slim` template, the `render` method can be used which takes one argument: a filename of another slim file.\nHere's an example:\n\n```slim\ndoctype html\nhtml lang='en'\n  head\n  body\n    == render \"_my_partial.slim\"\n```\n\nNote that the partial _must begin with an underscore_, and _files shouldn't begin with underscores unless they're partials_.\n\n _not every `slim` file is compiled to a corresponding `html` file_.\nThe `render` is run before the `slim=\u003ehtml` conversion, and concatenates the `slim` files.\n\nIts also possible to make custom helpers. Just add instance methods to the `helpers.rb` file\n\nScript files should be referenced from slim like `script src='./scripts/my_script.js'`\n\nStyle files should be referenced from slim like `link rel='stylesheet' href='./styles/my_style.css'`\n\nIt's possible to run the compilation step with `ruby gen.rb`, though this is done automatically when using `guard`\n\n## Webrick (static server)\n\nThe `ruby webrick.rb` command will `cd` into `dist/` and then run a static webrick server on port 8000.\n\n`guard` will run this command automatically\n\n## Guard (trigger builds and live-reload browser)\n\nThe app can be started with `guard`. This will read instructions from the `Guardfile`.\n\nWhenever `guard` is run, an initial compilation is run and the server starts.\n\nWhen the `Gemfile` changes, the server stops, `bundle` is automatically run, and the server starts up again\n\nWhen a file in the `dist/` folder changes, the browser will live-reload (make sure to install the livereload chrome extension to use this feature).\n\nWhen any other source file changes, the compilation step will be triggered.\n\n\n## Deploying to gh-pages\n\n1. Clone this repo, customize it however, and generate a site into `dist/`\n2. Run `push_dist_to_gh_pages`, which will push the `dist/` folder to the `gh-pages` branch on github.\n3. Visit the static site at `http://\u003cmy_github_username\u003e.github.io/\u003cmy_repo_name\u003e`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxpleaner%2Fmusicker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaxpleaner%2Fmusicker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxpleaner%2Fmusicker/lists"}