Getting Started (Ubuntu)

(I bought a new laptop and have to configure everything all over again. Feel it is a good chance for me to write a tutorial for new members to get started with ImageDatabase! This guide mostly work for mac users as well.)

Clone the repository

0-1. install git on your machine if you haven't by using command :

    sudo apt install git

0-2. following this step and add ssh key for your machine if you have not already done so. Cloning via SSH is considered more secure than HTTPS. https://help.github.com/en/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent

1. Go to the root page of this repository and find the button to clone the repository:

   

   copy everything from the text box.

2. clone the repository with command:

    git clone [what-you-just-copied]
   

Install Docker-Compose

Don't just use Ubuntu built-in apt-get install to install docker-compose. It is advised to follow strictly step-by-step the instructions here: https://docs.docker.com/compose/install/

Make sure (if you are using Ubuntu) that you have also seen these pages in the process:

https://docs.docker.com/install/linux/docker-ce/ubuntu/
https://docs.docker.com/install/linux/linux-postinstall/

Start the docker container

Then, follow instructions 1-6 in the README to start the docker container. (that is, everything before running the test.py script)

If the minio server is not running, you can refer to the minio part which is towards the end in the docker-compose.yml file. Find under name minio, there is a command: that specifies the command to start minio server. You can manually run it with command:

    docker-compose run [minio-command]

Return back to the repository root directory.

Python3 and virtual environment

We will be using python3 for the project.
With virtual environment, you can create a test environment and install all the dependencies here without messing up your own machine/working environment.

1. install pip for python3:

    sudo apt update
    sudo apt install python3-pip
   

2. install virtualenv with command:

    sudo python3 -m pip install virtualenv
   

   if not installing with sudo but with --user flag, the installation path, which might be somewhere in ~/.local/lib/pythonX.X/site-packages, might not be automatically added to PATH, thus you will need to manually add it to PATH or bashrc file

   You can make sure the virtualenv package is the most-up-to-date one by running this command:

    pip3 install --upgrade virtualenv
   

3. go to root directory of the repository and create an virtual environment that runs python3 with command:

    virtualenv -p python3 [your-environment-name]
   

   You will see a folder with the name you chose created.

4. start the virtual environment with command:

    source [your-environment-name]/bin/activate
   

5. install all dependencies with command:

    pip3 install -r requirements.txt
   

Try!

Continue steps in README from step 7.