{"id":31846876,"url":"https://github.com/frojd/phoenix-boilerplate","last_synced_at":"2025-10-12T09:17:32.203Z","repository":{"id":141912753,"uuid":"113041554","full_name":"Frojd/Phoenix-Boilerplate","owner":"Frojd","description":"A docker based boilerplate for Phoenix/Elixir","archived":false,"fork":false,"pushed_at":"2024-02-25T06:35:26.000Z","size":66,"stargazers_count":6,"open_issues_count":2,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-04-15T02:44:28.686Z","etag":null,"topics":["ansible","boilerplate","docker","phoenix"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Frojd.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2017-12-04T12:46:59.000Z","updated_at":"2024-02-29T07:20:39.000Z","dependencies_parsed_at":"2024-02-24T14:46:32.274Z","dependency_job_id":null,"html_url":"https://github.com/Frojd/Phoenix-Boilerplate","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/Frojd/Phoenix-Boilerplate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Frojd%2FPhoenix-Boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Frojd%2FPhoenix-Boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Frojd%2FPhoenix-Boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Frojd%2FPhoenix-Boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Frojd","download_url":"https://codeload.github.com/Frojd/Phoenix-Boilerplate/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Frojd%2FPhoenix-Boilerplate/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279010963,"owners_count":26084837,"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","status":"online","status_checked_at":"2025-10-12T02:00:06.719Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["ansible","boilerplate","docker","phoenix"],"created_at":"2025-10-12T09:17:31.220Z","updated_at":"2025-10-12T09:17:32.186Z","avatar_url":"https://github.com/Frojd.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Phoenix Boilerplate\n\nThis is a Phoenix/Elixir boilerplate that includes a auto-setup, docker support and deploy scripts.\n\n\n## Features\n\n- Built in compile target support for Ubuntu 22.04\n- Elixir 1.16\n- Phoenix 1.7\n- OTP 25\n- Auto scaffolding (with `phx.new`)\n- Dependencies and db migrations are automatically run when starting/restarting docker\n\n\n## Requirements\n\n- Docker ([Install instructions](#how-do-i-install-docker-on-macoswindows))\n- [mkcert](https://github.com/FiloSottile/mkcert) for SSL\n\n\n## Clean install\n\n1. Copy configuration\n\n    ```\n    cp docker/config/elixir.example.env docker/config/elixir.env\n    ```\n\n2. Open `docker/config/elixir.env` and change `SCAFFOLD_APP_NAME=` to the otp name you want for your app\n3. Run: docker-compose up\n4. Done. Visit [localhost:8000](http://localhost:8000)\n\n\n## Installation (when project is set up)\n\n### Running in docker\n\n1. Copy configuration\n\n    ```\n    cp docker/config/elixir.example.env docker/config/elixir.env\n    ```\n\n2. Include this ip on your hosts-file\n\n    ```\n    127.0.0.1 example.com.test\n    ```\n\n3. Add root cert: `mkcert -install` (if not already available)\n\n4. Generate ssl cert:\n    ```\n    mkcert --cert-file docker/files/certs/cert.pem --key-file docker/files/certs/cert-key.pem example.com.test\n    ```\n\n5. Enable SSL in Nginx\n    ```\n    sed -i.bak 's/\\#mkcert\\ //g' docker/files/config/nginx.conf.template\n    rm -f docker/files/config/nginx.conf.template.bak\n    ```\n\n6. Start project\n\n    ```\n    docker-compose up\n    ```\n\n7. Visit your site on [https://example.com.test:8001/](example.com.test:8001/)\n\n\n### Running elixir/otp locally\n\n1. Copy configuration\n\n    ```\n    cp docker/config/elixir.example.env docker/config/elixir.env\n    ```\n\n2. Include this ip on your hosts-file\n\n    ```\n    127.0.0.1 example.com.test\n    ```\n\n3. Add root cert: `mkcert -install` (if not already available)\n\n4. Generate ssl cert:\n    ```\n    mkcert --cert-file docker/files/certs/cert.pem --key-file docker/files/certs/cert-key.pem example.com.test\n    ```\n\n5. Enable SSL in Nginx\n    ```\n    sed -i.bak 's/\\#mkcert\\ //g' docker/files/config/nginx.conf.template\n    rm -f docker/files/config/nginx.conf.template.bak\n    ```\n\n6. Disable elixir docker image\n\n    ```\n    cp docker-compose.override.example.yml docker-compose.override.example.yml\n    ```\n\n7. Start project\n\n    ```\n    docker-compose up -d\n    ```\n\n8. Start phoenix\n    ```\n    cd src\n    mv local.tool-versions .tool-versions\n    asdf install\n    source env.local.sh\n    mix deps.get\n    mix phx.server\n    ```\n\n9. Visit your site on [https://example.com.test:8001/](example.com.test:8001/)\n\n\n## Deployment\n\n### Deploying manually\n\n#### Requirements\n\n- Python 3.8 and pip\n- Virtualenv\n- Mac OS or Linux ([Windows does not currently work](http://docs.ansible.com/ansible/latest/intro_windows.html#windows-how-does-it-work))\n\n#### How to\n\n1. Open deployment folder: `cd deploy`\n2. Setup and activate virtualenv: `virtualenv venv \u0026\u0026 venv/bin/activate`\n3. Install ansible: `pip install -r requirements.txt`\n4. Install ansistrano: `ansible-galaxy install -r requirements.yml`\n\n#### Deploy application\n\n- Stage: `ansible-playbook deploy.yml -i stages/stage.yml`\n- Prod: `ansible-playbook deploy.yml -i stages/prod.yml`\n\n\n## Style Guide\n\nWe use the build in elixir formatter:\n\n```\ndocker-compose exec elixir mix format\n```\n\n## FAQ\n\n\u003cdetails\u003e\n\n### How do I remove the scaffolded app?\n\n```\n./scripts/cleanup_scaffold.sh\n```\n\n### How do I run the test suite locally?\n\n```\ndocker-compose run --rm elixir test\n```\n\n\u003c/details\u003e\n\n\n## Learn more\n\n* Official website: http://www.phoenixframework.org/\n* Guides: http://phoenixframework.org/docs/overview\n* Docs: https://hexdocs.pm/phoenix\n* Mailing list: http://groups.google.com/group/phoenix-talk\n* Source: https://github.com/phoenixframework/phoenix\n\n\n## Contributing\n\nWant to contribute? Awesome. Just send a pull request.\n\n\n## License\n\nPhoenix Boilerplate is released under the [MIT License](http://www.opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrojd%2Fphoenix-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffrojd%2Fphoenix-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrojd%2Fphoenix-boilerplate/lists"}