pol.is an AI powered sentiment gathering platform. More organic than surveys, less effort than focus groups.
The installation instructions below are currently focused on setting up a development environment. These instructions should NOT be considered sufficient for production deployment without additional setup. We do NOT make guarantees of easy setup or management, push-button deployment, security, technical support, future migration paths, data integrity, etc.
Having said this, some of the core pieces of infrastructure described below are potentially useful in a production context, if used correctly.
In particular, each subdirectory of the project has its own
Dockerfile which could potentially be used as part of a deploy strategy.
docker-compose.yml is specifically focused on development environment flow.
- See also: Deployment: About SSL/HTTPS
If you'd like to set up your own deployment of Polis, we encourage your to reach out to us for support.
We look forward to working together
🙋🏾♀️ Get Involved
If you have a small machine or little hard drive space, you may want to consider running the below with Docker-Machine (DigitalOcean with 2GB memory should be sufficient)
Running with docker-compose:
Before running docker-compose up for the first time:
After cloning, navigate via command line to the root of this repository.
Next, either do a pull (faster):
If you get a permission error, try running
sudo docker-compose pull, and sudo will be necessary for all other commands as well. To avoid having to run
sudo in the future, you can follow setup instruction here: https://docs.docker.com/engine/install/linux-postinstall/
or do a build (to utilize recent or local changes):
docker-compose up --build
once you've either pulled or built, you can run the following when you want to run the project:
To force a full re-build with no cache from previous builds:
docker-compose build --parallel --no-cache
You can end the process using
Running as a background process
If you would like to run docker compose as a background process, run the
up commands with the
--detach flag, e.g.,:
docker-compose up --detach
And to stop:
check your ip (only necessary on docker-machine):
docker-machine ip >>> 188.8.131.52
Visit your instance at:
Or visit a native docker instance at
Sign up at
/createuser path. You'll be logged in right away; no email validation required!
What features still need work?
- Data export
Note: Due to past file re-organizations, you may find the following git configuration helpful for looking at history:
git config --local include.path ../.gitconfig
We use Cypress for automated, end-to-end browser testing! (See badge above.)