Skip to content

Commit 0dbe251

Browse files
aorumbayevaorumbayev
authored
fix: patch vscode launch config to account for no .env (#34)
* fix: patch vscode launch config to account for no .env * docs: refresh docs
1 parent 8701b24 commit 0dbe251

File tree

24 files changed

+149
-74
lines changed

24 files changed

+149
-74
lines changed

‎examples/generators/production_python_smart_contract_python/.algokit/generators/create_env_file/copier.yaml‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
_tasks:
22
- "echo '==== Successfully generated new .env file 🚀 ===='"
33

4-
use_generic_env:
5-
type: bool
6-
help: Create generic empty .env file (true) or create a network specific .env.{network_name} file (false).
7-
placeholder: "true"
8-
default: "true"
9-
104
target_network:
115
type: str
126
help: Name of your target network.

‎examples/generators/production_python_smart_contract_python/.algokit/generators/create_env_file/{% if use_generic_env %}.env{% endif %}‎

Whitespace-only changes.

‎examples/generators/production_python_smart_contract_python/.vscode/launch.json‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,14 @@
88
"module": "smart_contracts",
99
"cwd": "${workspaceFolder}",
1010
"preLaunchTask": "Start AlgoKit LocalNet",
11-
"envFile": "${workspaceFolder}/.env.localnet"
11+
"env": {
12+
"ALGOD_TOKEN": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
13+
"ALGOD_SERVER": "http://localhost",
14+
"ALGOD_PORT": "4001",
15+
"INDEXER_TOKEN": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
16+
"INDEXER_SERVER": "http://localhost",
17+
"INDEXER_PORT": "8980"
18+
}
1219
},
1320
{
1421
"name": "Deploy contracts",
@@ -17,7 +24,14 @@
1724
"module": "smart_contracts",
1825
"args": ["deploy"],
1926
"cwd": "${workspaceFolder}",
20-
"envFile": "${workspaceFolder}/.env.localnet"
27+
"env": {
28+
"ALGOD_TOKEN": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
29+
"ALGOD_SERVER": "http://localhost",
30+
"ALGOD_PORT": "4001",
31+
"INDEXER_TOKEN": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
32+
"INDEXER_SERVER": "http://localhost",
33+
"INDEXER_PORT": "8980"
34+
}
2135
},
2236
{
2337
"name": "Build contracts",

‎examples/generators/production_python_smart_contract_python/README.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,8 @@ Ensure the following pre-requisites are installed and properly configured:
2626
Run the following commands within the project folder:
2727

2828
- **Install Poetry**: Required for Python dependency management. [Installation Guide](https://python-poetry.org/docs/#installation). Verify with `poetry -V` to see version `1.2`+.
29-
- **Setup Project**: Execute `algokit project bootstrap all` to:
30-
- Install dependencies and setup a Python virtual environment in `.venv`.
31-
- Configure '.env' files if needed (see [AlgoKit Generators](#algokit-generators)).
29+
- **Setup Project**: Execute `algokit project bootstrap all` to install dependencies and setup a Python virtual environment in `.venv`.
30+
- **Configure environment**: Execute `algokit generate env-file -a target_network localnet` to create a `.env.localnet` file with default configuration for `localnet`.
3231
- **Start LocalNet**: Use `algokit localnet start` to initiate a local Algorand network.
3332

3433
### Development Workflow
@@ -74,7 +73,7 @@ By default the template creates a single `HelloWorld` contract under hello_world
7473
7574
### Generate '.env' files
7675

77-
By default the template instance would not contain any env files. Using [`algokit project deploy`](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/project/deploy.md) against `localnet` | `testnet` | `mainnet` will use default values for `algod` and `indexer` unless overwritten via `.env` or `.env.{target_network}`.
76+
By default the template instance does not contain any env files. Using [`algokit project deploy`](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/project/deploy.md) against `localnet` | `testnet` | `mainnet` will use default values for `algod` and `indexer` unless overwritten via `.env` or `.env.{target_network}`.
7877

7978
To generate a new `.env` or `.env.{target_network}` file, run `algokit generate env-file`### Continuous Integration / Continuous Deployment (CI/CD)
8079

‎examples/generators/production_python_smart_contract_typescript/.algokit/generators/create_env_file/copier.yaml‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
_tasks:
22
- "echo '==== Successfully generated new .env file 🚀 ===='"
33

4-
use_generic_env:
5-
type: bool
6-
help: Create generic empty .env file (true) or create a network specific .env.{network_name} file (false).
7-
placeholder: "true"
8-
default: "true"
9-
104
target_network:
115
type: str
126
help: Name of your target network.

‎examples/generators/production_python_smart_contract_typescript/.algokit/generators/create_env_file/{% if use_generic_env %}.env{% endif %}‎

Whitespace-only changes.

‎examples/generators/production_python_smart_contract_typescript/.vscode/launch.json‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,14 @@
1111
"console": "integratedTerminal",
1212
"skipFiles": ["<node_internals>/**", "node_modules/**"],
1313
"preLaunchTask": "Build contracts (+ LocalNet)",
14-
"envFile": "${workspaceFolder}/.env.localnet"
14+
"env": {
15+
"ALGOD_TOKEN": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
16+
"ALGOD_SERVER": "http://localhost",
17+
"ALGOD_PORT": "4001",
18+
"INDEXER_TOKEN": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
19+
"INDEXER_SERVER": "http://localhost",
20+
"INDEXER_PORT": "8980"
21+
}
1522
},
1623
{
1724
"name": "Deploy contracts",
@@ -22,7 +29,14 @@
2229
"cwd": "${workspaceFolder}/smart_contracts",
2330
"console": "integratedTerminal",
2431
"skipFiles": ["<node_internals>/**", "node_modules/**"],
25-
"envFile": "${workspaceFolder}/.env.localnet"
32+
"env": {
33+
"ALGOD_TOKEN": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
34+
"ALGOD_SERVER": "http://localhost",
35+
"ALGOD_PORT": "4001",
36+
"INDEXER_TOKEN": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
37+
"INDEXER_SERVER": "http://localhost",
38+
"INDEXER_PORT": "8980"
39+
}
2640
},
2741
{
2842
"name": "Build contracts",

‎examples/generators/production_python_smart_contract_typescript/README.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,8 @@ Ensure the following pre-requisites are installed and properly configured:
2626
Run the following commands within the project folder:
2727

2828
- **Install Poetry**: Required for Python dependency management. [Installation Guide](https://python-poetry.org/docs/#installation). Verify with `poetry -V` to see version `1.2`+.
29-
- **Setup Project**: Execute `algokit project bootstrap all` to:
30-
- Install dependencies and setup a Python virtual environment in `.venv`.
31-
- Configure '.env' files if needed (see [AlgoKit Generators](#algokit-generators)).
29+
- **Setup Project**: Execute `algokit project bootstrap all` to install dependencies and setup a Python virtual environment in `.venv`.
30+
- **Configure environment**: Execute `algokit generate env-file -a target_network localnet` to create a `.env.localnet` file with default configuration for `localnet`.
3231
- **Start LocalNet**: Use `algokit localnet start` to initiate a local Algorand network.
3332

3433
### Development Workflow
@@ -75,7 +74,7 @@ By default the template creates a single `HelloWorld` contract under hello_world
7574
7675
### Generate '.env' files
7776

78-
By default the template instance would not contain any env files. Using [`algokit project deploy`](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/project/deploy.md) against `localnet` | `testnet` | `mainnet` will use default values for `algod` and `indexer` unless overwritten via `.env` or `.env.{target_network}`.
77+
By default the template instance does not contain any env files. Using [`algokit project deploy`](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/project/deploy.md) against `localnet` | `testnet` | `mainnet` will use default values for `algod` and `indexer` unless overwritten via `.env` or `.env.{target_network}`.
7978

8079
To generate a new `.env` or `.env.{target_network}` file, run `algokit generate env-file`### Continuous Integration / Continuous Deployment (CI/CD)
8180

‎examples/generators/starter_python_smart_contract_python/.algokit/generators/create_env_file/copier.yaml‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
_tasks:
22
- "echo '==== Successfully generated new .env file 🚀 ===='"
33

4-
use_generic_env:
5-
type: bool
6-
help: Create generic empty .env file (true) or create a network specific .env.{network_name} file (false).
7-
placeholder: "true"
8-
default: "true"
9-
104
target_network:
115
type: str
126
help: Name of your target network.

‎examples/generators/starter_python_smart_contract_python/.algokit/generators/create_env_file/{% if use_generic_env %}.env{% endif %}‎

Whitespace-only changes.

0 commit comments

Comments
 (0)