Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alis-is/tea
Tezos contract development Environment by alis.is
https://github.com/alis-is/tea
dapp docker ligo smart-contracts taquito tezos
Last synced: 4 months ago
JSON representation
Tezos contract development Environment by alis.is
- Host: GitHub
- URL: https://github.com/alis-is/tea
- Owner: alis-is
- License: mit
- Created: 2022-09-04T16:59:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-17T20:57:56.000Z (8 months ago)
- Last Synced: 2024-04-17T21:54:51.724Z (8 months ago)
- Topics: dapp, docker, ligo, smart-contracts, taquito, tezos
- Language: Lua
- Homepage:
- Size: 250 KB
- Stars: 8
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
- awesome-tezos - Alis.is Tea
README
# TEA
TEA is small, adaptable and **self contained** development environment for Tezos smart contracts.
- small - dependencies of this project alone are only ~1.2MB
- adaptable - all behavior is determined based on [app.hjson](https://github.com/alis-is/tea/blob/main/app.hjson), can be tracked down and adjusted through [ami.lua](https://github.com/alis-is/tea/blob/main/ami.lua)
- self contained - all features as included within - adjust them anyway you like or need
Start your new Tezos project faster than you prepare cup of tea. :)
## What does TEA provide?
- **ligo** compilation and tests (*SmartPy is not supported right now but with TEA adaptability you can make it to.*)
- **taquito** based module for dapp development
- e2e tests with taquito and sandbox
## Dependencies
- eli and ami - for `ami` commands - only ~1.2MB
- (optional) [podman](https://podman.io/getting-started/installation) or [docker](https://docs.docker.com/engine/install/)
- (optional) [nodejs](https://nodejs.org/en/download/) for dapp development
- (optional) [esy](https://esy.sh/) for access to ligo package management
- For development on windows use [wsl2](https://docs.microsoft.com/en-us/windows/wsl/install)
## Get Started
### With Dev Container
1. Make sure you have [docker](https://docs.docker.com/engine/install/)
To store repository within the container:
2. Open dev container directly by clicking the container badge or [here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/alis-is/tea).
Or to store repository on local file system:
1. Clone repository
- `git clone https://github.com/alis-is/tea.git`
2. Choose `Reopen in Container` when prompted by VS Code.
### Lightweight local setup
1. Clone repository
- `git clone https://github.com/alis-is/tea.git`
2. Get `eli` and `ami` (lua engines powering tea)
- `wget -q https://raw.githubusercontent.com/alis-is/ami/master/install.sh -O /tmp/install.sh && sh /tmp/install.sh`
3. Install optional dependencies if needed
4. (optional) Edit `app.hjson` to adjust template behavior
- **You should set id to name of your project.** (Build and deploy commands use this id to name files)
5. `ami setup` (Downloads ligo and runs `ligo install` if needed)
6. (optional) to develop js module run `npm install` from within the `web` directory
7. You are ready to code
**NOTE**: *TEA is fully self contained template. No behavior is specified in outside packages or set in stone. You can adjust it however you like. Just edit behavior within `__tea` directory.* ;)
## Guide
TEA is operated with commands through `ami`. All commands respects your configuration within `app.hjson` and are defined within `ami.lua`
TEA provides bellow commands (see `--help` of each for details):
- `ami sandbox start` start sandbox
- `ami sandbox stop` stop sandbox
- `ami compile` compiles contract, initial storage and views
- `ami deploy ` deploys deploy or multiple based on id
- `ami test` runs ligo tests (stored in `tests`)
- `ami test-js` runs web module tests (stored in `web/tests`)
- *requires started sandbox*
- `ami test-js tests/admin.specs.js` runs `tests/admin.specs.js` tests
## Sample workflow
1. Code your contract
2. Run `ami compile` to compile contract and storage (See `--help` for options or selective compilation)
3. Run `ami test` to execute ligo tests
4. Run `ami deploy ` to deploy contract to your deploys
- `ami deploy sandbox` to deploy to sandbox with default `app.hjson`
5. Run `ami test-js` to test js-module
### Debug
You can examine all commands tea executes with log level debug:
- `ami -ll=debug ` e.g. `ami -ll=debug test`
## Development with VS Code
1. Install [Lua extension from sumneko](https://marketplace.visualstudio.com/items?itemName=sumneko.lua)
2. Run `ami download-dev-metas` to download meta definitions for autocomplete
3. Adjust template as needed. Entire template codebase is scoped within `__tea` directory.
## Projects using this template
- [Starlords](https://starlords.xyz/)
- [TzC](https://tez.capital/)