Notice

This is a work in progress Repo and not ready for Production uses yet.

Intial Setup

Native

1. Install PHP with minimum version of 8.2. If you cannot get PHP 8.2 on your machine consider using docker or another container solution.
2. Enable php extensions curl, iconv, mysqli, pdo_mysql, zip
3. Install Composer
4. Run composer install
5. Install npm
6. Run npm install && npm run build to install the necessary packages and prepare the javascript and css
7. Setup the required .env variables following Laravel Installation Documenation. It will be helpful to use the provided .env.example as a template.
8. To run locally for development use php artisan serve

Docker / Sail

1. Install docker and docker-compose
2. Setup the require .env variables following Laravel Installation Documenation
3. If you want to use sail then follow Laravel Sail Documentation skip the dev install step (it is already installed)
4. If you want to use base docker then you will need to setup your own docker compose file as of now a supported configuration is in the works.

Integrating with Current Symbiota

1. Copy or Clone BioKIC/Symbiota into this repo. in a new directory with the name of your choice (e.g., "Portal")
2. Add PORTAL_NAME= to your .env file and give it the name of the folder you just created
3. Setup the rest of the .env to connect DB secrets to match your symbiota config
4. Test by Navigating to a no laravel page like sitemap on the navbar
5. Note that, for some pages, the relative path of symbini.php may need to be changed. They can now reference the $SERVER_ROOT variable. For example, collections/search/index.php might need the line include_once('../../config/symbini.php'); changed to include_once($SERVER_ROOT . '/config/symbini.php');

Database

There are some small database additions do for some laravel features mostly surrounding the users. If you are upgrading from an existing schema make sure your Symbiota Schema is up to date with the latests Symbiota release. To do the upgrade first run the database/schema/upgrade.sql to populate migrations for tables that already exist in the symbiota schema. Then run the command php artisan migrate to popluate the remaing laravel tables.

Note: The files referenced in the current BioKIC/Symbiota that are placed into the new folder described above will not make use of any of laravel's features. This step is just a means to slowly port the project in a non blocking fashion.

Pages Running Laravel

Occurrence

• Profile
• Editor
• List Results
• Table Results

Collections

• Profile
• Permissions
• comments
• loans
• Specimen Labels
• Annotation Labels
• Batch Georef Tool
• Batch Determinations
• Darwin Core Archive Publishing
• Duplicate Manager
• Cleaning Tools
• Backup Download
• Resore Backup
• Thumbnail Maintenance
• Update Stats
• Editor
• Table Editor
• Specprocessor
  • Image Loading
  • Crowdsourcing
  • OCR
  • Reports
  • Exporter
  • GeoLocate

Upload

• Base Page
• Full Text File
• Skeletal File
• Darwin Core Archive Manual
• IPT Resource / Darwin Core Archive Provider
• NfN File
• Direct Database Mapping

Download

• Base Page UI
• Symbiota Schema
• Darwin Core Schema
• Multimedia extension
• Identifiers extension
• MeasurementOrFact extension

Media

• Profile
• Edit
• Search
• Creator Lookup

Taxonomy

• Profile
• Editor
• Tree Explorer

User

• Login
• Registration
• 2auth
• Oauth (Orcid)

Checklist

• Profile
• Admin Editor
• Voucher Editor

Maps

• Coordinate Aid
• Point Aid
• Occurrence | checklist Search
• Checklist/Profject map
• Taxon Thumbnail Generator

Misc

• Sitemap
• Datausage