Biokeeper

Citizen science biosample annotation tool

For users

Project structure

Repositories

The Biokeeper project file structure organized into several submodules for ease of development several logical parts of the project. Currently they are:

biokeeper # this repo, contains common docker-compose.yml to start all the server-side services
├── biokeeper-admin    # admin web page
├── biokeeper-auth     # users authentication service
├── biokeeper-backend  # core server-side application logic
├── biokeeper-frontend # React Native cross-platform app
└── biokeeper-mq       # RabbitMQ message broker

Microservice architecture

Start of work

First you need to clone this repo with all the submodues:

git clone --recurse-submodules [email protected]:phlaster/biokeeper.git
cd biokeeper

Then make sure you put relevant JWT public and private keys into jwt_keys/ directory and feel free to run:

docker-compose build
docker-compose up

For developers

Setting up GIT

To work on this or any child repo you need:

1. Set up your git credentials (where USERNAME is your user name):

   git config --global user.name "USERNAME"
   git config --global user.email [email protected]

2. In GitHub web UI FORK CHOSEN REPO.

3. Clone the repo to your local machine:

   git clone [email protected]:USERNAME/REPONAME.git
   cd REPONAME

4. Explicitly set upstream:

   git remote add upstream [email protected]:phlaster/REPONAME.git

5. Check that everything is as expected:

   git remote -v

   You should see something like:

   origin	[email protected]:USERNAME/REPONAME.git (fetch)
   origin	[email protected]:USERNAME/REPONAME.git (push)
   upstream	[email protected]:phlaster/REPONAME.git (fetch)
   upstream	[email protected]:phlaster/REPONAME.git (push)

6. Fetch updates from upstream repo:

   git fetch upstream

7. Merge updates with the branch of your choice:

   git checkout master
   git merge upstream/master
   # OR
   git checkout dev
   git merge upstream/dev

8. Then after work is done push changes into your personal repo:

   git push origin master
   # OR
   git push origin dev

Contributors

Mityamops	Momochka	kiriklzz	Rimk4
catfield123	d3biruwan	Lo-Lap	phlaster