cenoteandoDB / cenoteando

GitHub repository for Cenoteando project

Cenoteando

Backend:

Frontend:

Vue.js web application and Spring-boot API

a cenote information repository with ArangoDB database

for researchers, authorities and tourism

About • Technologies • Installation • Contributing • License

About

Cenoteando.org is a non-profit organization that focus on the shared development of a repository and database of all available data and information on the innundated caves or sinkholes of Yucatán, also known in spanish as "cenotes".

The multidisciplinary team and objetives behind the project cover both biophysical and socioeconomic variables with the hope to create and deliver impact assessment metrics to better manage touristic activities and other uses in the Yucatán cenotes.

We work closely with government authorities, academia, cenote owners and other stakeholders.

The academic branch team gather on a parallel project, cenoteando.mx, that centers on the unique underwater trophic webs in the Yucatán Cenotes. Current research aims at a better understanding of the stygobitic aquatic species taxonomy, systematics, behavior, interactions and distribution patterns. This group also invests a lot of energy into the communication of science through citizen science projects (iNaturalist) and visual materials such as infographics, posters and videos.

We are committed to the conservation and responsible use of the cenotes, as well as to the investigation of their resources, to create products for scientific, academic, social and tourist purposes that positively optimize the use of these natural assets that are so important for the local ecosystem.

Technologies

• Download required
  • Make
  • Docker
  • Docker Compose
• Frontend (development)
  • Node 16 (Node Version Manager recommended)
• Backend (development)
  • Java 17
  • Maven
• No download required
  • ArangoDB
  • Spring-boot
  • Vue.js

Installation

Debian

0. Clone repository and sub-modules

# Clone repository
git clone https://github.com/cenoteandoDB/cenoteando.git

# Change into cloned directory
cd cenoteando

# Checkout dev branch
git checkout dev

# Initialize submodules
git submodule init

# Update submodules
git submodule update

1. Update system and install dependencies

# Update apt index and upgrade packages
sudo apt update && sudo apt upgrade -y

# Install make and other build tools
sudo apt install build-essential

2. Install Docker

Follow instructions in Install Docker Engine on Debian.

As of Feb 2022, install instructions can be summarized as follows:

# Remove old versions (it's OK to ignore errors in this step)
sudo apt remove docker docker-engine docker.io containerd runc

# Install dependencies
sudo apt install -y \
    ca-certificates \
    curl \
    gnupg \
    lsb-release

# Add Docker's official GPG key
curl -fsSL https://download.docker.com/linux/debian/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg

# Add Docker repository
echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/debian \
  $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

# Install Docker
sudo apt update
sudo apt install -y docker-ce docker-ce-cli containerd.io

# Add current user to docker group
sudo usermod -aG docker $(whoami)

3. Install Docker Compose

Follow instructions in Install Docker Compose.

As of Feb 2022, install instructions can be summarized as follows:

# Download Docker Compose (version 1.29.2) binary
sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

# Apply executable permissions to the binary
sudo chmod +x /usr/local/bin/docker-compose

Install Docker Compose bash completion (optional):

# Download bash completions (version 1.29.2)
sudo curl \
    -L https://raw.githubusercontent.com/docker/compose/1.29.2/contrib/completion/bash/docker-compose \
    -o /etc/bash_completion.d/docker-compose

# Reload settings (alternatively, reload terminal)
source ~/.bashrc

4. Install Node.js for Frontend Development (optional)

Follow instructions in Installing Node Version Manager.

As of Feb 2022, install instructions can be summarized as follows:

# Download & run nvm install script (version 0.39.1)
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash

# Reload settings (alternatively, reload terminal)
source ~/.bashrc

# Install Node.js 16
nvm install 16

4. Install Java 17 for Backend Development (optional)

Download jdk-17_linux-x64_bin.deb from this link

Open a terminal in the directory where jdk-17_linux-x64_bin.deb is and run the following commands:

# Install Oracle JDK 17 (it's OK to ignore unmet dependencies)
sudo dpkg -i jdk-17_linux-x64_bin.deb

# Fix missing dependencies
sudo apt --fix-broken install

5. Reboot

sudo reboot

6. Setup Google Cloud credentials (optional)

Add your credentials.json file to backend/secrets/. This file is only required to be able to see photos, maps and references on your local instance.

7. Run project

make start

• Access http://localhost to see the frontend
• The backend is mounted at http://localhost/api
• Access http://localhost:8529 to navigate the database
• Check out the documentation. (COMING SOON)

Contributing

Your contributions are always welcome! Please have a look at the contribution guidelines first.

We strive for a respectful and inclusive community. Interactions not respecting our code of conduct will not be tolerated.

License

This project is licensed under the MIT License - see the LICENSE file for details.