⚠️ The DataJoint LabBook project is still early in its life and the maintainers are currently actively developing with a priority of addressing first critical issues directly related to the deliveries of Alpha and Beta milestones. Please be advised that while working through our milestones, we may restructure/refactor the codebase without warning until we issue our Official Release currently planned as0.1.0
on2021-03-31
.
A frontend with graphical user interface for DataJoint pipelines built using React.
This repo is the single source of truth for development efforts on DataJoint LabBook frontend development.
For now, development observes the following policy for branches:
dev
: Feature-complete, DEMO-ready progress. Might be a bit rough around the edges or lacking in docs, tests but functional. Demonstrates latest features that have been completed.master
: Polished, release-ready source with relevant docs, tests. More stable and less likely to undergo any refactoring/restructuring.
- Copy a
*-docker-compose.yaml
file corresponding to your usage todocker-compose.yaml
. This file is untracked so feel free to modify as necessary. Idea is to commit anything generic but system/setup dependent should go on 'your' version i.e. local UID/GID, etc. - Check the first comment which will provide the best instruction on how to start the service; yes, it is a bit long. Note: Any of the keyword arguments prepended to the
docker-compose
command can be safely moved into a dedicated.env
and read automatically if they are not evaluated i.e.$(...)
. Below is a brief description of the non-evaluated environment variables:
PY_VER=3.8 # (pharus) Python version: 3.6|3.7|3.8
IMAGE=djtest # (pharus) Image type: djbase|djtest|djlab|djlabhub
DISTRO=alpine # (pharus) Distribution: alpine|debian
pharus
is treated as a backend dependency managed by git's builtin submodules. It allows us to nest entire git repos with separate history and easy access. Below are some helpful commands to be used after cloning the source repo.
git submodule init
then git submodule update
git submodule foreach git pull
git submodule add -b master [email protected]:datajoint/pharus.git
- Pharus (a DataJoint REST API backend):
- Under construction image credits: