Skip to content
Go to file

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

Installation Instructions

  1. git clone

  2. Install Node, MySQL and Wget:

    1. Windows installation
      1. Windows users follow the link to install Node:
      2. When installing MySQL server, make sure the lower_case_table_names is set to 2 and that passwords use Legacy Authentication Method is selected
      3. Make sure wget is in your path.
    2. OSX installation

      OSX users need to follow the given steps:

      1. Install brew.
      2. brew install node
      3. Install nginx using brew.
      4. brew install mysql
      5. Install wget using homebrew:
    3. Debian / Ubuntu

      1. sudo apt install nodejs mysql-server wget
  3. Start mysql: mysql.server start (On Ubuntu: sudo service mysql start or sudo systemctl mysql start )

  4. Open mysql console using sudo mysql (if root user is created, you may need to do sudo mysql -u root -p)

  5. Run the following sql commands on the mysql shell

CREATE USER 'converge'@'localhost' IDENTIFIED WITH mysql_native_password BY 'password';
GRANT ALL PRIVILEGES ON * . * TO 'converge'@'localhost';
  1. Run the following command to reset the password of any user (if required).

     ALTER USER 'root'@'localhost' IDENTIFIED BY 'MyNewPassword'; 
  2. Create the necessary mysql database. In the cartoscope backend directory:

mysql -u converge -p convergeDB < database_migrations/dump.sql

  1. Create directories. In the cartoscope backend directory:

mkdir temp
mkdir dataset
  1. Setup SSL Certificates:

    Cartoscope requires SSL certificates for running on HTTPS. Run this command:
openssl req \
       -newkey rsa:2048 -nodes -keyout domain.key \
       -x509 -days 365 -out domain.crt

For more information, follow this link:

  1. Set environment variables in bashrc (replace with your values. For a test / personal use, consider 8081, 8082 as the PORTS)

     export CARTO_DB_USER=converge                                                         
     export CARTO_DB_PASSWORD=password                                                     
     export CARTO_DB_NAME=convergeDB                                                       
     export CARTO_MAILER=''                                         
     export CARTO_SALT='$$$$$$$$$$$$$$$$$$$$$$'
     export CARTO_PORT=80
     export CARTO_PORT_SSL=443
     export CARTO_SSL_KEY='path/to/your/certificate.key'
     export CARTO_SSL_CRT='path/to/your/certificate.crt'
  2. Python related installations:

    Make sure pip is installed and then intall PIL
    sudo easy_install pip
    Sudo pip install pillow
  3. Install required npm modules for backend and frontend:

    cd cartoscope-backend
    npm install -g bower
    npm install
    cd ./public
    bower install
  4. To facilitate development, also install nodemon with npm install -g nodemon

  5. Start Server

    cd ../cartoscope-backend
    nodemon app
  6. Setup Users etc.

    1. Your main page is at http://localhost:CARTO_PORT (where CARTO_PORT is the port specified in the environment variables)
    2. For the remainder of the instructions, we will use port 8081 as the selected port:
    3. In order to start setting up projects, you will need to register a user by going to http://localhost:8081/#/login
    4. Make sure your registered user's name is cartoproject for project creation privileges to apply.
    5. Login with the user and create a project
    6. Caution The current setup does not provide a graphical interface for creating project tutorials. This can be accomplished by adding the image files to the cartoscope_backend/public/images/Tutorials/ folder and adding the relevant information to the


No description, website, or topics provided.




No releases published


No packages published
You can’t perform that action at this time.