Skip to content
This repository has been archived by the owner on Apr 10, 2020. It is now read-only.

Commit

Permalink
Moved system component descriptions into table.
Browse files Browse the repository at this point in the history
  • Loading branch information
patcon committed Nov 4, 2018
1 parent 9901a89 commit 330d776
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,23 @@ If you're interested in deploying Polis, or setting up a development environment

First things first, it helps to understand a bit how the system is set up.

The main server is a node app located at https://github.com/pol-is/polisServer.
This handles web requests from clients, including page loads, vote activity, etc.

The next big piece is the math engine, located at https://github.com/pol-is/polisMath.
This piece is written in Clojure, and thus runs on the JVM.

Client code has been separated out into https://github.com/pol-is/polisClientParticipation and https://github.com/pol-is/polisClientAdmin.
The code in these repos compile to static assets.
| Component Name | Tech | Description |
|----------------|------|-------------|
| [`polisServer`][repo-server] | Node.js | The main server. Handles client web requests (page loads, vote activity, etc.) |
| [`polisMath`][repo-math] | Clojure/JVM | The math engine. |
| [`polisClientParticipation`][repo-participation] | Javascript | The client code for end-users. |
| [`polisClientAdmin`][repo-admin] | Javascript | The client code for administrators. |

The code in the two client-side repos compile to static assets.
We push these to s3 for CDN via `deployPreprod` and `deploy_TO_PRODUCTION`, but there is a config file for each of these projects which will allow you to configure the behavior of these scripts as described in the READMEs.
Of note though, you can use a static file server, and deploy via these scripts over `sshfs`.
Finally, for local development, these repos have hot-reload able servers you can run with the `./x` command, but note that this is not the recommended approach for serving the client assets in production.

[repo-server]: https://github.com/pol-is/polisServer
[repo-math]: https://github.com/pol-is/polisMath
[repo-participation]: https://github.com/pol-is/polisClientParticipation
[repo-admin]: https://github.com/pol-is/polisClientAdmin

### Environment variables and configuration

Each of these applications currently takes configuration from a set of environment variables.
Expand Down

0 comments on commit 330d776

Please sign in to comment.