An open source implementation of CosmoQuest's Citizen Science Builder software.

This is an open source image annotation platform suitable for citizen science, complete with native machine learning tools that can be trained through contributed data.

Copyright © 2012-2022 CosmoQuest X Team is led by Pamela Gay with the Development team and maintained through community collaboration. All rights reserved.

Images, videos and other media belong to their respective owners.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

To get a production build of the software, go the latest master CI run and download the csb-build artifact.

CSB 7.0 has been tested in our sandbox environment, which uses PHP 8.1. The Docker configuration is configured to use PHP 8.1, as well.

If you have not yet updated to PHP 8.1 from PHP 7.4 or earlier, you may want to consider doing this, however there is no requirement to do this. You can find out more information about PHP's supported versions at https://www.php.net/supported-versions.php.

To install SASS, follow instructions on https://sass-lang.com/install. Once things are installed, you'll need to compile your sass files into css files whenever the sass is edited.

To watch and compile sass on the command line run:

sass --watch csb-themes/default/sass/style.scss:csb-themes/default/style.css

PHPstorm can watch and compile sass (see https://www.jetbrains.com/help/phpstorm/transpiling-sass-less-and-scss-to-css.html).

Instructions on compiling SASS in ubuntu are here: https://webdesign.tutsplus.com/tutorials/watch-and-compile-sass-in-five-quick-steps--cms-28275

CSB defines Apache error documents. If you want them to extend to the whole server, move the .htaccess file to the document root.

• Setup an Apache 2 / MySQL 8 / PHP 8 environment. If we don't have specific instructions you need below, look for instructions for Wordpress. Our setup should be the same.
  • OSX
    • Enable Apache apachectl start
    • In /etc/apache2/httpd.conf
      • Uncomment LoadModule statements for php7 and mod_rewrite Use Legacy Password Encryption
      • Set AllowOverride All
    • Restart Apache sudo apachectl restart
    • Install MySQL
    • Add mysql to your .bash_profile by adding export PATH="/usr/local/mysql/bin:$PATH"
  • Ubuntu: find the Digital Ocean Tutorial for your version of Ubuntu
  • Windows: to be determined

If you don't have a LAMP (or Win AMP) setup, find instructions to install Wordpress. This software requires the same kind of server configuration! For ubuntu, the Digital Ocean tutorials are among the best.

• You should always use a certificate. If you don't have one, try using the free Let's Encrypt: CertBot.

• MacOS Mojave use: https://tobschall.de/2018/08/07/pear-on-mojave/
• General installation use: https://pear.php.net/manual/en/installation.getting.php

• Go to https://yourhost/csb-installer/ in your browser. This will let you configure your installation and then install databases and setup an admin user using the settings in csb-settings.php

• Download and install the corresponding docker desktop version for your OS from Docker

• For Windows - open either Command Console or Powershell. For Mac or Linux - open your command shell.

• Execute the following command from the CSB directory: docker-compose up

• To stop docker and close the app, press Ctrl+C

• Go to https://localhost:8080/csb/csb-installer/ in your browser.
  • To use the docker MariaDB, use db as your database hostname
  • Default docker username, password, and database are all csb