Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/intersectmbo/plutus-tx-template
This is a template repository for kickstarting your plutus-tx smart contract project. Please refer to the README.md for more information.
https://github.com/intersectmbo/plutus-tx-template
Last synced: about 1 month ago
JSON representation
This is a template repository for kickstarting your plutus-tx smart contract project. Please refer to the README.md for more information.
- Host: GitHub
- URL: https://github.com/intersectmbo/plutus-tx-template
- Owner: IntersectMBO
- License: apache-2.0
- Created: 2024-03-19T14:04:16.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-10-24T05:55:19.000Z (about 2 months ago)
- Last Synced: 2024-10-25T00:08:06.320Z (about 2 months ago)
- Language: Haskell
- Homepage:
- Size: 85.9 KB
- Stars: 14
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Plutus Tx Template
A template repository for your `plutus-tx` smart contract project.
`plutus-tx` currently supports GHC `v9.2.x` and `v9.6.x`. Cabal `v3.8+` is recommended.
### 1. Create the repository
- From the command line:
```
gh repo create my-project --private --template IntersectMBO/plutus-tx-template
```
- Or from the [GitHub web page](https://github.com/IntersectMBO/plutus-tx-template), click the top-right green button:
`Use this template -> Create new repository`
- Or just fork/clone `plutus-tx-template` (but note that this is a template repository)
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).
### 2. Setup your development environment
- With Nix (**recommended**)
Follow [these instructions](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/getting-started/install.md) to install and configure nix, even if you already have it installed.
Then enter the shell using `nix develop`.
The nix files inside this template follow the [`iogx` flake](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` flavours.
- With Docker / Devcontainers / Codespaces
From the [GitHub web page](https://github.com/IntersectMBO/plutus-tx-template), click the top-right green button:
`Use this template -> Open in a codespace`
Or let VSCode create a local codespace for you when you open this project.
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)).
Or using your local docker installation (change the `/path/to/my-project` accordingly):
```
docker run \
-v /path/to/my-project:/workspaces/my-project \
-it ghcr.io/input-output-hk/devx-devcontainer:x86_64-linux.ghc96-iog
```
When using this approach, you can ignore/delete/replace the nix files entirely.
- With manually-installed dependencies (**not recommended**)
Follow the instructions for [cardano-node](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/getting-started/install.md) for a custom setup.
When using this approach, you can ignore/delete/replace the nix files entirely.
### 3. Run the example application
Run `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.