photoprism/development repository overview

Before you start, make sure you have Git⁠ and Docker⁠ installed on your system. Instead of using Docker, you can create your own development environment based on our Dockerfile⁠ (not recommended). You'll need Go⁠ >= 1.17, TensorFlow for C⁠, Make⁠, NPM⁠ and MySQL⁠. Without Docker, test results will be less reliable and you also won't be able to use our other Dockerfiles (e.g. for TensorFlow).

Step 1: Run Git⁠ to clone this project:

git clone [email protected]:photoprism/photoprism.git

Step 2: Start Docker⁠ containers:

cd photoprism
docker-compose up

Note: This docker-compose configuration is for testing and development purposes only.

Step 3: Open a terminal to the photoprism container:

docker-compose exec photoprism bash

Now - inside this terminal - you can run tests and commands:

make all
make test
./photoprism start

You can see a list of all make targets in our Makefile⁠. For example, make install will build a photoprism production binary without debug information and install it in the user's directory including all assets.

./photoprism start starts the built-in Web server. It will listen on localhost:2342⁠ by default, see docker-compose.yml⁠.

Continue reading in our Developer Guide⁠