{"id":28762792,"url":"https://github.com/intersectmbo/plinth-template","last_synced_at":"2025-10-27T04:19:40.162Z","repository":{"id":228758023,"uuid":"774412620","full_name":"IntersectMBO/plinth-template","owner":"IntersectMBO","description":"This is a template repository for kickstarting your Plinth smart contract project.  Please refer to the README.md for more information.","archived":false,"fork":false,"pushed_at":"2025-06-12T12:02:23.000Z","size":162,"stargazers_count":19,"open_issues_count":1,"forks_count":6,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-12T13:20:30.818Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Haskell","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/IntersectMBO.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS.md","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-03-19T14:04:16.000Z","updated_at":"2025-06-06T19:25:46.000Z","dependencies_parsed_at":"2024-04-25T11:25:54.023Z","dependency_job_id":"1b6516ee-3300-41fc-8a10-9aa8f8ab75ef","html_url":"https://github.com/IntersectMBO/plinth-template","commit_stats":null,"previous_names":["intersectmbo/plutus-tx-template","intersectmbo/plinth-template"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/IntersectMBO/plinth-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntersectMBO%2Fplinth-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntersectMBO%2Fplinth-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntersectMBO%2Fplinth-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntersectMBO%2Fplinth-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IntersectMBO","download_url":"https://codeload.github.com/IntersectMBO/plinth-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntersectMBO%2Fplinth-template/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260324898,"owners_count":22992277,"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":"2025-06-17T08:40:25.558Z","updated_at":"2025-10-27T04:19:40.156Z","avatar_url":"https://github.com/IntersectMBO.png","language":"Haskell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Plinth Template Repository \n\nA template repository for your Plinth smart contract project.\n\nPlinth currently supports GHC `v9.6.x`. Cabal `v3.8+` is recommended.\n\n### 1. Create the repository\n\n- From the command line:\n\n  ```\n  gh repo create my-project --private --template IntersectMBO/plinth-template\n  ```\n\n- Or from the [GitHub web page](https://github.com/IntersectMBO/plinth-template), click the top-right green button:\n\n  `Use this template -\u003e Create new repository`\n\n- Or just fork/clone `plinth-template` (but note that this is a template repository)\n\n  More information on GitHub template repositories can be found [here](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).\n\n### 2. Setup your development environment\n\n\u003cdetails\u003e\n  \u003csummary\u003e With Nix (\u003cb\u003erecommended\u003c/b\u003e) \u003c/summary\u003e\n\n  1. Follow [these instructions](https://github.com/input-output-hk/iogx/blob/main/doc/nix-setup-guide.md) to install and configure nix, \u003cb\u003eeven if you already have it installed\u003c/b\u003e.\n     \n  2. Then enter the shell using `nix develop`.\n\n  \u003e NOTE:  \n  \u003e The nix files inside this template follow the [`iogx` template](https://github.com/input-output-hk/iogx), but you can delete and replace them with your own. In that case, you might want to include the [`devx` flake](https://github.com/input-output-hk/devx/issues) in your flake inputs as a starting point to supply all the necessary dependencies, making sure to use one of the `-iog` flavors.\n\n  \u003e NOTE (for Windows users):\u003cbr\u003e\n  \u003e Make sure to have [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install#upgrade-version-from-wsl-1-to-wsl-2) and the [WSL](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl) VSCode extension (if using VSCode) installed before the Nix setup.\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e With Docker / Devcontainer / Codespaces \u003c/summary\u003e\n  \n  - **Docker + Codespaces:** From the [GitHub web page](https://github.com/IntersectMBO/plinth-template), click the top-right green button:\n\n    `Use this template -\u003e Open in a codespace`\n\n  - **Docker + Devcontainer:**\n    1. Make sure to have [VSCode](https://code.visualstudio.com/) installed with the [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension.\n    2. Open this project in VSCode and let it create a local codespace for you (See Dev Containers instructions, if needed).\n\n  - **Stand-alone Docker:** Change the `/path/to/my-project` accordingly and run:\n\n  ```\n    docker run \\\n      -v /path/to/my-project:/workspaces/my-project \\\n      -it ghcr.io/input-output-hk/devx-devcontainer:x86_64-linux.ghc96-iog\n  ```\n\n  \u003e NOTE:\n  \u003e You can modify your [`devcontainer.json`](./.devcontainer/devcontainer.json) file to customize the container (more info [here](https://github.com/input-output-hk/devx?tab=readme-ov-file#vscode-devcontainer--github-codespace-support)).\n\n  \u003e NOTE:  \n  \u003e When using this approach, you can ignore/delete/replace the Nix files entirely.\n\n  \u003e NOTE (for Windows users):\u003cbr\u003e\n  \u003e It is recommended to install and run Docker on your native OS. If you want to run Docker Desktop inside a VM, read through [these notes](https://docs.docker.com/desktop/setup/vm-vdi/).\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e With Demeter \u003c/summary\u003e\n  \n  1. Create an account in [Demeter](https://demeter.run/).\n  \n  2. Follow [their instructions](https://docs.demeter.run/guides/getting-started) to setup a remote development environment.\n\n  \u003e IMPORTANT:  \n  \u003e Demeter uses its own infrastructure and packages. If something is not working correctly, please contact them before creating an issue.\n\n  \u003e NOTE:  \n  \u003e When using this approach, you can ignore/delete/replace the Nix files entirely.\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e With manually-installed dependencies (\u003cb\u003enot recommended\u003c/b\u003e) \u003c/summary\u003e\n  \u003cbr\u003e\n  \n  Follow the instructions for [cardano-node](https://developers.cardano.org/docs/get-started/cardano-node/installing-cardano-node/) for a custom setup.\n\n  \u003e NOTE:  \n  \u003e When using this approach, you can ignore/delete/replace the Nix files entirely.\n\u003c/details\u003e\n\n### 3. Run the example application\n\nRun `cabal update` first, then read [Example: An Auction Smart Contract](https://plutus.cardano.intersectmbo.org/docs/category/example-an-auction-smart-contract) to get started.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintersectmbo%2Fplinth-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fintersectmbo%2Fplinth-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintersectmbo%2Fplinth-template/lists"}