search

zetkin / call.zetk.in

Caller interface for Zetkin.
4 stars 4 forks source link

readme

Zetkin Call, call.zetk.in

Zetkin Call is the caller interface of Zetkin, the platform for organizing activism.

Zetkin is developed by the Zetkin Foundation and friends. If you want to learn more about Zetkin or help out with development, you can find more information at the Zetkin Foundation website or The Zetkin Manual.

Getting started

To get started with development you need Docker. Install Docker for your platform before proceeding.

Get the Git

First clone the repository. Make sure that you include the git submodules by including the --recursive flag.

$ git clone --recursive https://github.com/zetkin/call.zetk.in.git

If you have already cloned the repository without --recursive, you can achieve the same effect manually. You also need to do this after every new pull.

$ git submodule init
$ git submodule update

Scripts

Mac and Linux

Once you have cloned the repository, build the Docker image:

$ ./bin/build_dev

Docker will download all the requirements and create an image which you can then use to run the Zetkin Activist portal on your local port 80.

$ ./bin/run_dev

The development version contains build scripts, component hot loading and other features to ease development.

Windows

On Docker file system watching is broken on Windows. We have to rely on the Python (3+) package docker-windows-volume-watcher. This does not seem to work on Windows 10 Home with VirtualBox.

Once you have cloned the repository and made sure you have Python installed, build the Docker image:

./bin/build_dev.cmd

Docker will download all the requirements and create an image which you can then use to run the Zetkin Activist portal on your local port 80.

./bin/run_dev.cmd

The development version contains build scripts, component hot loading and other features to ease development.

Host

Edit your hosts file (e.g. /etc/hosts) to contain a line that maps call.dev.zetkin.org to your localhost.

127.0.0.1       call.dev.zetkin.org

This ensures that you can sign in to your local version of the portal using the development version of the Zetkin Platform API (api.dev.zetkin.org). Just point your browser to call.dev.zetkin.org, which is now your local version, and start using it. Edit javascript code and components will be reloaded instantly in your browser.

NOTE: SCSS files are not hot reloaded. You must reload the page, or install a browser extension to reload just the CSS files, to see changes after editing SCSS.