@@ -12,7 +12,8 @@ Sets up a new development environment for a Mac or Linux (i.e., UNIX) box.
12
12
* [ mvp] ( #mvp )
13
13
* [ Summary] ( #summary )
14
14
* [ Setup] ( #setup )
15
- * [ Quickstart] ( #quickstart )
15
+ * [ Minimum requirements] ( #minimum-requirements )
16
+ * [ Recommended requirements] ( #recommended-requirements )
16
17
* [ Development] ( #development )
17
18
* [ Makefile] ( #makefile )
18
19
* [ Taskfile] ( #taskfile )
@@ -21,7 +22,7 @@ Sets up a new development environment for a Mac or Linux (i.e., UNIX) box.
21
22
* [ Further Reading] ( #further-reading )
22
23
23
24
## Setup
24
- * Minimum requirements
25
+ ### Minimum requirements
25
26
* [ Python 3.11] ( https://www.python.org/downloads/ )
26
27
* Dev dependencies
27
28
* make
@@ -30,12 +31,9 @@ Sets up a new development environment for a Mac or Linux (i.e., UNIX) box.
30
31
* [ editorconfig] ( https://editorconfig.org/ )
31
32
* [ wsl] ( https://docs.microsoft.com/en-us/windows/wsl/setup/environment )
32
33
33
- ## Quickstart
34
- * Install python and tooling
35
- ``` bash
36
- # install python and dependencies (e.g., git, ansible, etc.)
37
- ./bootstrap install
38
- ```
34
+ ### Recommended requirements
35
+ * [ devbox] ( https://www.jetpack.io/devbox/docs/quickstart/ )
36
+ * [ task] ( https://taskfile.dev/#/installation )
39
37
40
38
## Development
41
39
### Makefile
@@ -72,20 +70,29 @@ task: Available tasks for this project:
72
70
```
73
71
74
72
### Devbox
75
- I.e., [Nix Package Manager](https://search.nixos.org/packages)
73
+ Devbox takes care of setting up a dev environment automatically. Under the hood it uses [ Nix Package Manager] ( https://search.nixos.org/packages ) .
74
+
75
+ Currently, it supports the following:
76
+ * [ asdf] ( https://asdf-vm.com/guide/getting-started.html#_2-download-asdf )
77
+ * [ docker] ( https://docs.docker.com/compose/install/ )
78
+ * [ gh] ( https://cli.github.com/manual/ )
79
+ * [ minikube] ( https://minikube.sigs.k8s.io/docs/start/ )
80
+ * [ nodejs (21.4)] ( https://nodejs.org/en/download/ )
81
+ * [ poetry] ( https://python-poetry.org/docs/ )
82
+ * [ python (3.11)] ( https://www.python.org/ )
83
+ * [ task] ( https://taskfile.dev/#/installation )
84
+ * [ tilt] ( https://docs.tilt.dev/install.html )
85
+
76
86
``` bash
77
87
# enter dev environment
78
88
devbox shell
79
89
80
- # run individual app
81
- python < sign_jwt | meetup_query | slackbot | main > .py
90
+ # run repl
91
+ python
82
92
83
93
# exit dev environment
84
94
exit
85
95
86
- # run standalone server
87
- devbox run start
88
-
89
96
# run tests
90
97
devbox run test
91
98
```
0 commit comments