You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-5Lines changed: 9 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,10 +16,12 @@ For a detailed methods paper, see [Polis: Scaling Deliberation by Mapping High D
16
16
<br/>
17
17
18
18
19
-
### 🎈 🪁 Start here! 🪁🎈
19
+
### 🎈 🪁 Start here! 🪁🎈
20
20
21
21
If you're interested in using or contributing to Polis, please see the following:
22
22
-[📚 **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
23
25
-[💬 **discussions**][discussions]: for questions (QA) and discussion
24
26
-[✔️ **issues**][issues]: for well-defined technical issues
25
27
-[🏗️ **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
43
45
44
46
## ⚡ Running Polis
45
47
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).
47
49
As a consequence, the only prerequisite to running Polis is that you install a recent `docker` (and Docker Desktop if you are on Mac).
48
50
49
51
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.
78
80
79
81
### Testing out your instance
80
82
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`.
82
84
83
85
Once the index page loads, you can create an account using the `/createuser` path.
84
86
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
118
120
119
121
## 💻 Development tooling
120
122
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
122
124
123
125
```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
125
127
```
126
128
129
+
(run with `--build` if this is your first time running, or if you need to rebuild containers)
130
+
127
131
This enables:
128
132
* Live code reloading and static type checking of the server code
129
133
* A nREPL connection port open for connecting to the running math process
0 commit comments