{"id":18021358,"url":"https://github.com/2mol/elm-quickstart","last_synced_at":"2025-04-04T17:23:37.793Z","repository":{"id":146590076,"uuid":"194080200","full_name":"2mol/elm-quickstart","owner":"2mol","description":null,"archived":false,"fork":false,"pushed_at":"2019-07-31T15:04:48.000Z","size":16,"stargazers_count":11,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-10T02:45:57.053Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Makefile","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/2mol.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":"2019-06-27T11:08:22.000Z","updated_at":"2020-04-15T17:43:12.000Z","dependencies_parsed_at":"2023-04-01T13:20:31.697Z","dependency_job_id":null,"html_url":"https://github.com/2mol/elm-quickstart","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2mol%2Felm-quickstart","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2mol%2Felm-quickstart/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2mol%2Felm-quickstart/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2mol%2Felm-quickstart/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/2mol","download_url":"https://codeload.github.com/2mol/elm-quickstart/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247218073,"owners_count":20903193,"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-10-30T06:09:37.325Z","updated_at":"2025-04-04T17:23:37.771Z","avatar_url":"https://github.com/2mol.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Elm-quickstart template\n\n```\n$ make help\n\nUsage:\n  make \u003ctarget\u003e\n\nTargets:\n  site       Build site with optimize and compress resulting javascript.\n  site-dev   Build site without optimizing.\n  watch      Watch files for changes and recompile when necessary.\n  help       Show this help.\n```\n\nIt usually takes me a little bit of time to get started with a new elm project. But I wanna get started right away, as fast as possible! 🚀\n\nI tend to copy-paste some boilerplate from other projects, so I collected some of it in this template repository. I hope to keep things simple while still providing functionality like recompiling on file changes etc.\n\nThis is tailored to my preferences, like using a simple `Makefile` to collect the various build/deploy/live-reload commands I need. I am open to changing things to make it more useful for other people.\n\nI just found out about [GitHub templates](https://github.blog/2019-06-06-generate-new-repositories-with-repository-templates), which is a nice fit for this sort of setup. Just use the green button above.\n\n## Dependencies\n\nThere are some basic dependencies that help my development workflow a lot:\n\n- [`ripgrep`](https://github.com/BurntSushi/ripgrep)\n- [`entr`](http://entrproject.org)\n- [`uglifyjs`](https://github.com/mishoo/UglifyJS2)\n\nInstall the first two with your package manager of choice, on mac I just do `brew install ripgrep entr`.\n\nInstall `uglifyjs` with `npm install -g uglify-js`. This is used to massively reduce the file size of the resulting .js file, adapted from [https://guide.elm-lang.org/optimization/asset_size.html](https://guide.elm-lang.org/optimization/asset_size.html).\n\nIf anybody thinks that these dependencies could (and should) be simplified even further, I am open to suggestions and pull requests. Just open an issue to discuss.\n\n## Go go go\n\nAfter cloning this repo as a template (github: green button above), all you have to do is remove this glorious `README` and initialize the elm project:\n\n```bash\nrm Readme.md\nelm init\n```\n\nRun `make help` to \n\nIf you clone directly with `git clone`, remember to also nuke the local git repo:\n\n```\nrm -rf .git\ngit init\n```\n\n## Deployment\n\nThis template doesn't really include any deployment commands, since these generally differ a lot from project to project.\n\nAs an example, for a server you have ssh access to, using `rsync` as follows is my favourite. I only syncs modified files and it deletes anything on the target that was removed in your local folder:\n\n```\nrsync -crv -e ssh --delete site/ $(USER)@$(SERVER):$(FOLDER)\n```\n\nIn other situations, I deploy on github-pages or the amazing [Netlify](https://netlify.com)!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F2mol%2Felm-quickstart","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F2mol%2Felm-quickstart","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F2mol%2Felm-quickstart/lists"}