Skip to content
This repository has been archived by the owner on Nov 27, 2024. It is now read-only.

Commit

Permalink
Merge pull request #14 from algorandfoundation/readme-fix
Browse files Browse the repository at this point in the history
chore: readme whitespace fix
  • Loading branch information
robdmoore authored Mar 28, 2023
2 parents c4111d5 + 61539c5 commit 37af2e1
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 12 deletions.
2 changes: 1 addition & 1 deletion template_content/README.md.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This project has been generated using AlgoKit. See below for default getting sta
- Copy `.env.template` to `.env`
{%- if deployment_language == "typescript" %}
- Run `npm install` in `smart_contracts` to install NPM packages
{% endif -%}
{% endif %}
3. Open the project and start debugging / developing via:
- VS Code
1. Open the repository root in VS Code
Expand Down
25 changes: 14 additions & 11 deletions tests/test_default_parameters/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@ This project has been generated using AlgoKit. See below for default getting sta

### Initial setup

1. Clone this repository: `git clone {repository_url}`
1. Clone this repository locally
2. Install pre-requisites:
- If you have AlgoKit installed, run `algokit bootstrap poetry` within this folder;
- or:
- Install `Python` - [Link](https://www.python.org/downloads/): The minimum required version is `3.10`. Ensure you can execute `python -V` and get `3.10`+.
- Install `Poetry` - [Link](https://python-poetry.org/docs/#installation): The minimum required version is `1.2`. Ensure you can execute `poetry -V` and get `1.2`+.
- If you're not using PyCharm, then run `poetry install` in the root directory (this should set up `.venv` and also install all Python dependencies) - PyCharm will do this for you automatically on startup 🪄.
- Install `AlgoKit` - [Link](https://github.com/algorandfoundation/algokit-cli#install): Ensure you can execute `algokit --version`.
- Bootstrap your local environment; run `algokit bootstrap all` within this folder, which will:
- Install `Poetry` - [Link](https://python-poetry.org/docs/#installation): The minimum required version is `1.2`. Ensure you can execute `poetry -V` and get `1.2`+
- Run `poetry install` in the root directory, which will set up a `.venv` folder with a Python virtual environment and also install all Python dependencies
- Copy `.env.template` to `.env`
3. Open the project and start debugging / developing via:
- VS Code
1. Open the repository root in VS Code
2. Install recommended extensions
3. Hit F5 (or whatever you have debug mapped to) and it should start running with breakpoint debugging.
> **Note**
> If using Windows: Before running for the first time you will need to select the Python Interpreter.
1. Open the command palette (Ctrl + P)
1. Open the command palette (Ctrl/Cmd + Shift + P)
2. Search for `Python: Select Interpreter`
3. Select `./.venv/Scripts/python.exe`
- IDEA (e.g. PyCharm)
Expand All @@ -34,16 +34,19 @@ This project has been generated using AlgoKit. See below for default getting sta

### Subsequently

1. If you update to the latest source code and there are new dependencies you will need to run `poetry install` again
1. If you update to the latest source code and there are new dependencies you will need to run `algokit bootstrap all` again
2. Follow step 3 above

# Tools

This project makes use of Python to build Algorand smart contracts. The following tools are in use:

- [Algorand](https://www.algorand.com/) - Layer 1 Blockchain; [Developer portal](https://developer.algorand.org/), [Why Algorand?](https://developer.algorand.org/docs/get-started/basics/why_algorand/)
- [AlgoKit](https://github.com/algorandfoundation/algokit-cli) - One-stop shop tool for developers building on the Algorand network; [docs](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/algokit.md), [intro tutorial](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/tutorials/intro.md)
- [Beaker](https://github.com/algorand-devrel/beaker) - Smart contract development framework for PyTeal; [docs](https://beaker.algo.xyz), [examples](https://github.com/algorand-devrel/beaker/tree/master/examples)
- [PyTEAL](https://github.com/algorand/pyteal) - Python language binding for Algorand smart contracts; [docs](https://pyteal.readthedocs.io/en/stable/)
- [AlgoKit Utils](https://github.com/algorandfoundation/algokit-utils-py) - A set of core Algorand utilities that make it easier to build solutions on Algorand.
- [Poetry](https://python-poetry.org/): Python packaging and dependency management.- [Black](https://github.com/psf/black): A Python code formatter.
- [Ruff](https://github.com/charliermarsh/ruff): An extremely fast Python linter.

- [mypy](https://mypy-lang.org/): Static type checker.

It has also been configured to have a productive dev experience out of the box in VS Code, see the [.vscode](./.vscode) folder.
- [mypy](https://mypy-lang.org/): Static type checker.It has also been configured to have a productive dev experience out of the box in VS Code, see the [.vscode](./.vscode) folder.

0 comments on commit 37af2e1

Please sign in to comment.