Skip to content

Commit 11be8d7

Browse files
Merge pull request #103 from CodeForPhilly/ts/update-readme
Add laddr dev instructions to README
2 parents 2250f61 + 0c3c23b commit 11be8d7

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,36 @@
11
# codeforphilly.org
22

3-
Code for Philly's customizations to laddr
3+
## Overview
4+
5+
Code for Philly's website repository built as an extension of [laddr](https://github.com/CodeForPhilly/laddr), a website building tool designed specifically for civic hacking groups.
6+
7+
## Developing
8+
9+
The following is directly taken from the [Getting started guide on laddr's README](https://github.com/CodeForPhilly/laddr#getting-started).
10+
11+
### Dependencies
12+
13+
Install recent versions of [Habitat](http://habitat.sh) and [Docker](https://www.docker.com/) on your Linux, Mac, or Windows workstation.
14+
15+
### Clone Laddr
16+
17+
```bash
18+
cd ~/Repositories/laddr # or wherever you cloned this rep
19+
20+
# expose port 7080 (http) and 3306 (mysql) from any Docker container started by Habitat
21+
export HAB_DOCKER_OPTS="-p 7080:7080 -p 3306:3306"
22+
23+
# launch and enter a Habitat studio
24+
hab studio enter
25+
26+
# once the studio has finished loading, start all services with a local database
27+
start-all
28+
29+
# clone a production instance's database
30+
load-sql https://codeforphilly.org
31+
32+
# build and load the site, then wait for file changes
33+
watch-site
34+
```
35+
36+
At that point you should be able to see an instance at http://localhost:7080 and any edits should be reflected live

0 commit comments

Comments
 (0)