{"id":21590998,"url":"https://github.com/toolsplus/atlassian-connect-play-seed","last_synced_at":"2025-06-29T15:35:21.030Z","repository":{"id":51428764,"uuid":"86296437","full_name":"toolsplus/atlassian-connect-play-seed","owner":"toolsplus","description":null,"archived":false,"fork":false,"pushed_at":"2023-01-27T01:47:03.000Z","size":305,"stargazers_count":1,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-18T10:15:30.013Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Scala","has_issues":true,"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/toolsplus.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}},"created_at":"2017-03-27T05:54:50.000Z","updated_at":"2022-09-09T06:52:45.000Z","dependencies_parsed_at":"2023-02-15T04:02:16.914Z","dependency_job_id":null,"html_url":"https://github.com/toolsplus/atlassian-connect-play-seed","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/toolsplus/atlassian-connect-play-seed","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toolsplus%2Fatlassian-connect-play-seed","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toolsplus%2Fatlassian-connect-play-seed/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toolsplus%2Fatlassian-connect-play-seed/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toolsplus%2Fatlassian-connect-play-seed/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/toolsplus","download_url":"https://codeload.github.com/toolsplus/atlassian-connect-play-seed/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toolsplus%2Fatlassian-connect-play-seed/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262619788,"owners_count":23338332,"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-11-24T16:21:42.000Z","updated_at":"2025-06-29T15:35:21.011Z","avatar_url":"https://github.com/toolsplus.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"Atlassian Connect Play Seed\n===========================\n\n[![Build Status](https://github.com/toolsplus/atlassian-connect-play-seed/workflows/CI/badge.svg)](https://github.com/toolsplus/atlassian-connect-play-seed/actions)\n[![codecov](https://codecov.io/gh/toolsplus/atlassian-connect-play-seed/branch/master/graph/badge.svg)](https://codecov.io/gh/toolsplus/atlassian-connect-play-seed)\n\n\nThis project serves as a starter for Atlassian Connect add-ons\nbased on [Atlassian Connect Play](atlassian-connect-play).\n\n## Quick start\n\n1. Start by cloning this repository \n1. Install ngrok\n\n    To install a Atlassian Connect add-on on a Cloud instance it has to be served \n    over HTTPS. This can easily be done using [ngrok](ngrok). Make sure you have it\n    installed and a tunnel started using\n           \n           ngrok http 9000\n           \n    ngrok will display the base URL for your add-on. Use it to configure the `AC_BASE_URL`\n    parameter in the [run configuration](#run-configuration).\n\n1. Configure the Play application\n\n    You can configure your Play application via `conf/application.conf`.\n    Atlassian Connect Play provides the following configuration parameters:\n    \n        atlassian.connect {\n          key = io.toolsplus.acplayscala\n          name = \"Atlassian Connect Play\"\n          baseUrl = \"localhost:9000\"\n          allowReinstallMissingHost = true\n        }\n        \n    `atlassian.connect.key` is your add-on's unique key\n    `atlassian.connect.name` is your add-on's name that you can choose freely\n    `atlassian.connect.baseUrl` is your ngrok HTTPS URL if you develop locally, \n    otherwise the HTTPS URL of where your add-on lives\n    `atlassian.connect.allowReinstallMissingHost` when set to true will not allow\n    to re-install a missing host, should be set to false for developer purposes\n    \n1. Configure a database\n\n    This project is configured to use Postgres backend storage via \n    [Atlassian Connect Play Slick](atlassian-connect-play-slick). Follow the guide\n    there on how to configure a different database system if you wish to use something\n    else.\n    \nThat's it. You're add-on should now be ready to go.\n\n## Configuration via environment variables\n\nAlternatively to configuring your add-on via `conf/application.conf` you can configure\nsome properties via environment variables. The following lists the parameters\navailable by default:\n\n    AC_BASE_URL=https://my-host.ngrok.io\n    AC_ALLOW_REINSTALL_MISSING_HOST=true\n    SLICK_DBS_DEFAULT_DRIVER=slick.driver.PostgresDriver$\n    SLICK_DBS_DEFAULT_DB_URL=jdbc:postgresql:acpsseed\n    SLICK_DBS_DEFAULT_DB_DRIVER=org.postgresql.Driver\n    SLICK_DBS_DEFAULT_DB_USER=sa\n    SLICK_DBS_DEFAULT_DB_PASSWORD=\n    \nIf you need other parameters exposed as environment variables you can easily add\nthen to the `conf/application.conf`. See examples in `conf/application.conf` on \nhow to do this.\n\n\n## Contributing\n \nPull requests are always welcome. Please follow the [contribution guidelines](CONTRIBUTING.md).\n    \n## License\n\natlassian-connect-play-seed is licensed under the **[Apache License, Version 2.0][apache]** (the\n\"License\"); you may not use this software except in compliance with the License.\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n[atlassian-connect-play]: https://github.com/toolsplus/atlassian-connect-play\n[atlassian-connect-play-slick]: https://github.com/toolsplus/atlassian-connect-play-slick\n[ngrok]: https://ngrok.com/\n[apache]: http://www.apache.org/licenses/LICENSE-2.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoolsplus%2Fatlassian-connect-play-seed","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftoolsplus%2Fatlassian-connect-play-seed","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoolsplus%2Fatlassian-connect-play-seed/lists"}