Skip to content

Commit da0b686

Browse files
docs: getting started
1 parent c5a823b commit da0b686

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
@@ -10,13 +10,39 @@ There are three ways to get started with Laddr:
1010
- [Clone laddr](#clone-laddr) to work on and contribute to its core, shared functionality
1111
- [Extend laddr](#extend-laddr) to create a workspace for customizing a copy of laddr for your brigade without forking the whole thing
1212

13+
### Dependencies
14+
15+
Install recent versions of [Habitat](http://habitat.sh) and [Docker](https://www.docker.com/) on your Linux, Mac, or Windows workstation.
16+
1317
### Clone Laddr
1418

15-
*TODO: document me*
19+
```bash
20+
cd ~/Repositories/laddr # or wherever you cloned this rep
21+
22+
# expose port 7080 from any Docker container started by Habitat
23+
export HAB_DOCKER_OPTS="-p 7080:7080"
24+
25+
# launch and enter a Habitat studio
26+
hab studio enter
27+
28+
# once the studio has finished loading, start all services with a local database
29+
start-all-local
30+
31+
# build and load the site, then wait for file changes
32+
watch-site
33+
```
34+
35+
At that point you should be able to see an instance at http://localhost:7080 and any edits should be reflected live
1636

1737
### Extend Laddr
1838

19-
*TODO: document me*
39+
*TODO: Extending project docs*
40+
41+
```bash
42+
# build the codeforphilly example extending project instead
43+
export EMERGENCE_HOLOBRANCH=example-codeforphilly
44+
watch-site
45+
```
2046

2147
## Support
2248

0 commit comments

Comments
 (0)