CONTRIBUTING.md

Contributing

Welcome! As a Jupyter project, we follow the Jupyter contributor guide.

Minikube

To develop binderhub, you can use a local installation of JupyterHub on minikube, and run binderhub on the host system.

1. Install Minikube and start it: minikube start.

   For MacOS, you may find installing from https://github.com/kubernetes/minikube/releases may be more stable than using Homebrew.

2. Install helm

   curl https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get | bash

   Alternative methods for helm installation exist if you prefer installing without using the script.

3. Initialize helm in minikube

   helm init

4. Add the JupyterHub helm charts repo:

   helm repo add jupyterhub https://jupyterhub.github.io/helm-chart/
   helm repo update

5. Install JupyterHub in minikube with helm

    helm install jupyterhub/jupyterhub --version=v0.5.x-2140cd6 \
        --name=binder \
        --namespace=binder \
        -f testing/minikube/jupyterhub-helm-config.yaml
   

6. Install binderhub:

    python3 -m pip install -e .
   

7. Start binderhub with the testing config file:

    python3 -m binderhub -f testing/minikube/binderhub_config.py
   

8. Visit http://localhost:8585

All features should work, including building and launching.

Pure HTML / CSS / JS development

If you do not want to set up minikube but just want to hack on the html / css / js, there is a simpler method!

1. Install binderhub:

   python3 -m pip install -e .

2. Run it!

   python3 -m binderhub.app -f testing/localonly/binderhub_config.py

3. You can now access it locally at https://localhost:8585

Note that building and launching will not work!