spesql

A portal for interacting with a remote MySQL database, written in TypeScript (React & Electron).

About This Project

This project was developed for the McGuire Center of Lepidoptera and Biodiversity (MGCL) at the Florida Museum of Natural History (FLMNH). It provides researchers a portal for managing their collection datasets, hosted on remote, MySQL servers, as well as tools for summary statistic analysis.

Installation

Please select and download a release for your platform (i.e. Linux, MacOS, Windows) and proceed with the traditional installation procedure for your platform. You'll need to install UF's VPN Client, as well.

Startup & Usage

Ensure your UF VPN is connected and launch the application. For detailed information about usage, please read through the official documentation: flmnh-mgcl.github.io/spesql/docs/. This will walk you through all the available features/functions in the software.

If you do not have access credentials you may request an account in the application directly and an admin will review. If you have any other issues or concerns, please contact the Kawahara Lab directly for support. If you are an employee and need additional assistance, please refer to the instructional videos, website documentation or contact the Kawahara Lab directly, as well.

Development Information

You will need LTS Node and Yarn installed on your machine. Be sure to obtain an .env file from the lab in order to run the application in a development environment. Once you have these completed, you can install the dependencies by running the following in the project root directory:

yarn

Startup

To start the app in development mode:

yarn dev

Builds and Releases

To create a build, you need only to run yarn release once on any machine, and then the following FOR EACH platform (i.e. Windows and MacOS):

yarn build

yarn release will prompt for an updated version and create release tags on GitHub.

yarn build will create a dist folder in the project root directory. You can use previous releases as examples for what needs to be uploaded, however the itemized list is:

• MacOS
  • latest-mac.yml
  • spesql-VERSION-mac.zip
  • spesql-VERSION-mac.dmg
  • spesql-VERSION-mac.dmg.blockmap
• Windows
  • latest.yml
  • spesql.Setup.VERSION.exe
  • spesql.Setup.VERSION.blockmap

Website Deployment

To deploy changes to the documentation website, you will need to run the following:

GIT_USER=<GITHUB_USERNAME> yarn deploy

Database Schema

The main database schema that the client assumes is largely structured from Darwin Core principles.

Known Issues / Bugs

Please refer to issues labeled with bug to view the current list of issues that may or may not affect your usage of spesql.

Contact / Issue Reporting

Aaron Leopold developed this software. If there are any questions regarding the usage of the application, please contact him via email ([email protected]). Additionally, if you are an employee of the FLMNH, refer to the recorded instructional videos (check #database in the Slack workspace) for more in-depth demonstrations. For issues relating to software bugs, glitches or unexpected errors, please submit a GitHub issue. Be sure to describe in detail the errors, bugs or glitches that have occurred, and include the steps to reproduce the error. Feel free to submit issues for feature requests, as well, for any features you think should be added or changed.