-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
4 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,7 @@ | ||
# Tact template project | ||
# TACT template project | ||
|
||
This template comes pre-configured to kickstart your new Tact project. It includes the Tact compiler, TypeScript, Jest integrated with [tact-emulator](https://github.com/tact-lang/tact-emulator), and a sample demonstrating how to run tests. | ||
This project has ready to use TACT compiler, typescript + jest with ton-contract-executor, example how to do tests. | ||
|
||
```shell | ||
yarn test # To test contract | ||
yarn build # To build contract | ||
yarn lint # To find code issues in contract | ||
yarn deploy # To deploy contract | ||
``` | ||
## Licence | ||
|
||
## Deployment | ||
|
||
To deploy a contract, follow these steps: | ||
|
||
1. Define the [`contract.tact`](./sources/jetton_minter.tact) file that will be used as entry point of your contract. | ||
2. Customize the [`contract.deploy.ts`](./sources/contract.deploy.ts) file based on your `contract.tact` to generate a deployment link. It is crucial to ensure the proper invocation of the `init()` function within the contract. | ||
|
||
If you rename `contract.tact`, make sure to update [`tact.config.json`](./tact.config.json) correspondingly. Refer to the [Tact Documentation](https://docs.tact-lang.org/language/guides/config) for detailed information. | ||
|
||
## Testing | ||
|
||
You can find some examples of contract tests in [`contract.spec.ts`](./sources/contract.spec.ts). For more information about testing, see the [Tact Documentation](https://docs.tact-lang.org/language/guides/debug). | ||
|
||
To add new test files to your contracts, you should create `*.spec.ts` files similar to the template's one and they would be automatically included in testing. | ||
|
||
## License | ||
|
||
MIT | ||
MIT |