Skip to content

Commit 49ded38

Browse files
authored
Smooth readme dev section (#1538)
* smooth out readme dev section * clarify --build use in dev section of README
1 parent 0aed01b commit 49ded38

1 file changed

Lines changed: 9 additions & 5 deletions

File tree

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,12 @@ For a detailed methods paper, see [Polis: Scaling Deliberation by Mapping High D
1616
<br/>
1717

1818

19-
### 🎈 🪁 Start here! 🪁🎈
19+
### 🎈 🪁 Start here! 🪁 🎈
2020

2121
If you're interested in using or contributing to Polis, please see the following:
2222
- [📚 **knowledge base**][knowledge-base]: for a comprehensive wiki to help you understand and use the system
23+
- [🌐 **main deployment**](https://pol.is): the main deployment of Polis is at <https://pol.is>, and is
24+
free to use for nonprofits and government
2325
- [💬 **discussions**][discussions]: for questions (QA) and discussion
2426
- [✔️ **issues**][issues]: for well-defined technical issues
2527
- [🏗️ **project board**][board]: somewhat incomplete, but still useful; We stopped around the time that Projects Beta came out, and we have a [Projects Beta Board][beta-board] that we'll eventually be migrating to
@@ -43,7 +45,7 @@ If you're trying to set up a Polis deployment or development environment, then p
4345

4446
## ⚡ Running Polis
4547

46-
Polis comes with Docker infrastructure for running a complete system.
48+
Polis comes with Docker infrastructure for running a complete system, whether for a [production deployment](#-production-deployment) or a [development environment](#-development-tooling) (details for each can be found in later sections of this document).
4749
As a consequence, the only prerequisite to running Polis is that you install a recent `docker` (and Docker Desktop if you are on Mac).
4850

4951
If you aren't able to use Docker for some reason, the various `Dockerfile`s found in subdirectories (`math`, `server`, `*-client`) of this repository _can_ be used as a reference for how you'd set up a system manually.
@@ -78,7 +80,7 @@ Any time you want to _rebuild_ the images, just reaffix `--build` when you run.
7880

7981
### Testing out your instance
8082

81-
You can now test your setup by visiting `http://localhost:80/`.
83+
You can now test your setup by visiting `http://localhost:80/home`.
8284

8385
Once the index page loads, you can create an account using the `/createuser` path.
8486
You'll be logged in right away; email validation is not required.
@@ -118,12 +120,14 @@ However, if you are deploying in a high impact context and need help, please [re
118120

119121
## 💻 Development tooling
120122

121-
Once you've gotten [Polis running (as described above)](#-running-polis), you can enable developer conveniences by executing:
123+
Once you've gotten [Polis running (as described above)](#-running-polis), you can enable developer conveniences by running
122124

123125
```bash
124-
docker compose up -f docker-compose.yml -f docker-compose.dev.yml
126+
docker compose -f docker-compose.yml -f docker-compose.dev.yml up
125127
```
126128

129+
(run with `--build` if this is your first time running, or if you need to rebuild containers)
130+
127131
This enables:
128132
* Live code reloading and static type checking of the server code
129133
* A nREPL connection port open for connecting to the running math process

0 commit comments

Comments
 (0)