Skip to content
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions {{ cookiecutter.project_name_dashed }}/.tool-versions
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
poetry 1.8.5
python {{ cookiecutter.python_version }}
10 changes: 10 additions & 0 deletions {{ cookiecutter.project_name_dashed }}/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ help:
@echo " \033[1m\033[35mdocs\033[0m \033[37m(d)\033[0m: \033[36mGenerate project documentation.\033[0m\n"

@echo "Environment Management --------------------------------------------------------"
@echo " \033[1m\033[35masdf-install\033[0m \033[37m(asdfi)\033[0m: \033[36mTry to install tools listed in .tool-versions.\033[0m"
@echo " \033[1m\033[35mclean-venv\033[0m \033[37m(cv)\033[0m: \033[36mRemove virtual environment.\033[0m"
@echo " \033[1m\033[35minstall\033[0m \033[37m(i)\033[0m: \033[36mInstall app and dependencies.\033[0m"
@echo " \033[1m\033[35mvenv\033[0m \033[37m(v)\033[0m: \033[36mCreate virtual environment.\033[0m\n"
Expand All @@ -39,6 +40,15 @@ help:
# NOTE: Do not modify the autogenerated targets, unless necessary, write custom
# targets in the custom section below..

.PHONY: asdf-install
asdf-install:
@echo "\nInstalling ASDF Plugins & Tools +++++++++++++++++++++++++++++++++++++++++++++++\n"
@cat .tool-versions | cut -d' ' -f1 | grep "^[^\#]" | xargs -I {} asdf plugin add {}
@asdf install

.PHONY: asdfi
asdfi: asdf-install

.PHONY: clean-venv
clean-venv:
@echo "\nRemoving the virtual environment ++++++++++++++++++++++++++++++++++++++++++++++\n"
Expand Down
20 changes: 20 additions & 0 deletions {{ cookiecutter.project_name_dashed }}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
- [Development](#development)
- [Makefile](#makefile)
- [Environment reproducibility](#environment-reproducibility)
- [asdf](#asdf)
- [Dev containers](#dev-containers)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
Expand Down Expand Up @@ -126,6 +127,24 @@ make u

### Environment reproducibility

Below mentioned are some tools and configuration that you can use to make your
environment development-ready. This is optional and opinionated but can help you
set up your environment quickly.

#### asdf

We recommend using [asdf][asdf] to manage your development environment. Take a
look at the `.tool-versions` file to see the versions of the tools used in this
project. Additionally, you can use the make command to install all the required
tools at once.

```sh
make asdfi
```

> **Note:** The above command might not install all the tools required, so make
> sure to install the tools that are not installed manually.

#### Dev Containers

Our project supports [Dev Containers][devcontainers] for an easy and reproducible
Expand Down Expand Up @@ -196,6 +215,7 @@ To get in touch with us, please use one of the following routes:

[![logo-elixir]][elixir] [![logo-elixir-cloud-aai]][elixir-cloud-aai]

[asdf]: https://asdf-vm.com/
[badge-chat-url]: https://join.slack.com/t/elixir-cloud/shared_invite/enQtNzA3NTQ5Mzg2NjQ3LTZjZGI1OGQ5ZTRiOTRkY2ExMGUxNmQyODAxMDdjM2EyZDQ1YWM0ZGFjOTJhNzg5NjE0YmJiZTZhZDVhOWE4MWM
[badge-license-url]: http://www.apache.org/licenses/LICENSE-2.0
[code-of-conduct]: https://elixir-cloud-aai.github.io/about/code-of-conduct/
Expand Down