Skip to content

Latest commit

 

History

History
163 lines (122 loc) · 5.33 KB

README.md

File metadata and controls

163 lines (122 loc) · 5.33 KB
Raw

XRONOS web app

Website Tests Test coverage Docker pulls GitHub issues GitHub pull requests GitHub last commit

DOI

This repository contains the source code for the web application at the core of XRONOS, an open infrastructure for chronometric data from archaeological contexts worldwide. It uses Ruby on Rails, Hotwire and Bootstrap 5.

XRONOS is an open source project and contributions to this repository are welcome from anyone. If you find a bug or have a suggestion to improve XRONOS, please create an issue.

Server setup

Start the system

Create a directory with the following content

your_directory
|- db
|- docker-compose.yml
|- env_variables.env

db: An empty directory that will contain the database.
docker-compose.yml: A docker-compose.yml file (example)
env_variables.env: A file with environment variables.

# Database credentials
POSTGRES_DB=...
POSTGRES_USER=...
POSTGRES_PASSWORD=...
# Passphrase the users must know to register
REGISTRATION_PASSPHRASE=...

Inside of this directory you can then run

docker-compose up -d

For the first start the database migrations have to be run. This has to be done within the container. Change into the container with

docker exec -it xronos_rails_app /bin/bash

Then inside of the container run

rails db:migrate

Leave the container with

exit

Update the system

docker pull xronos/xronos.rails
docker-compose up -d --no-deps --build web

Stop the system

docker-compose stop

Stop and delete the system

docker-compose down

Development

For development, you will need to run the XRONOS rails app directly (without docker):

  1. Clone this repository
  2. Ensure ruby, bundler, yarn, and postgresql are installed on your system
    • Using rbenv or a similar solution to manage ruby versions is highly recommended
  3. Create a postgresql user for xronos with CREATEDB privileges
  4. Create a .env file in the root of the repository (see above for a template)
  5. Run bundle && yarn to install gem and javascript dependencies respectively
  6. Run bin/rails db:setup to set up and seed the database
  7. Start a dev server with bin/dev. This watches for changes in CSS and JS files.
    • If you get an error about foreman being missing, try restarting your terminal.

Using Calibrator

The calibrator is a small command-line tool written in C++ used in XRONOS to calibrate the 14C data live. To use it in your test environment, you need to compile it for your system. This process varies depending on the system, but we provide a brief description for Linux and MacOS below.

Prerequisites

The calibrator requires the Boost C++ library. Ensure that Boost is installed and accessible on your system. You may need to modify the Makefile to specify the correct locations for the includes and libraries. The compilation also depends on having make and the g++ compiler installed.

To install these tools, follow the instructions for your operating system:

For Linux:

  • Arch Linux: 
    sudo pacman -Sy base-devel
  • Ubuntu: 
    sudo apt install build-essential

For MacOS:

  • Install Xcode Command Line Tools: 
    xcode-select --install

You might already have these tools installed. To check, run:

make --version
gcc --version

Compilation Steps

  1. Navigate to the calibrator directory: Open a terminal and change to the vendor/calibrator directory within the XRONOS project.

    cd vendor/calibrator

  2. Clean previous builds (optional but recommended):

    make clean

  3. Compile the calibrator:

    make

  4. Rename the resulting binary: Rename the compiled calibrator file to a name appropriate for your operating system.

    • For Linux: 
      mv bin/calibrator bin/calibrator_linux
    • For MacOS: 
      mv bin/calibrator bin/calibrator_mac

This should make the calibrator available for use in XRONOS. You may also find the tool useful for other purposes. If you encounter issues or need further assistance, please refer to the calibrator GitHub page.