Skip to content

Commit 6dd4a52

Browse files
committed
Update README to reflect new dev setup routine
1 parent 63d9089 commit 6dd4a52

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,38 @@ If you are interested in getting involved with the project, check out [our page
4444

4545
## Local Development Setup
4646

47+
Clone this repository:
4748
```bash
4849
git clone https://github.com/CodeForPhilly/benefit-decision-toolkit.git
50+
```
4951

52+
Go to the project's root directory:
53+
```bash
5054
cd benefit-decision-toolkit
5155
```
5256

53-
You can find instructions to work on each app within the project in their respective directories, which are linked above.
57+
To setup using the pre-defined [Devbox](https://www.jetify.com/docs/devbox/) configuration:
58+
*Note that this installs Devbox and Nix (if they aren't already installed).
59+
```bash
60+
bin/install-devbox && devbox run setup
61+
```
62+
63+
If you don't want to use devbox/nix, then you can install system dependencies (e.g. JDK, Node, Maven) manually (see devbox.json for the list) and run:
64+
```bash
65+
bin/setup
66+
```
67+
68+
If using devbox, then run the shell to load dependencies:
69+
```bash
70+
devbox shell
71+
# Consider using direnv and/or the VS Code extensions (Devbox and Direnv) to automate this step.
72+
```
73+
74+
Then start apps as needed, e.g.:
75+
```bash
76+
cd builder-frontend && npm run dev
77+
```
78+
79+
You can find additional instructions to work on each app within the project in their respective directories, which are linked above.
5480

55-
Note that for the frontend apps, you will need an environment variable file from a teammate. Please do not commit this file to the repo.
81+
Note that for the frontend apps, you will need a .env file from a teammate. Please do not commit this file to the repo.

0 commit comments

Comments
 (0)