Running your own instance

⏲️ Getting started in 5 minutes¶

If you just want to try the application, the easiest way is to go to the hosted version at: https://app.opencloning.org/.

If you want to quickly set up a local instance of the application using docker, you can clone this repository, and from the root directory call:

# see docker-compose.yml
docker-compose up

The application should be running at http://localhost:8000.

This uses the provided docker-compose.yaml.

Scripting¶

You can use the backend library to script and automate cloning design. Have a look at the scripting documentation for more information.

Running it yourself using docker in a single container¶

You can use the image manulera/opencloning, and use docker-compose.yaml as a starting point. The important information to know is that:

The image exposes port 8000.
You can configure several things via ENV variables, see the comments in the docker-compose.yaml file:
Proxy for external requests
Usage of HTTPS
Root path at which the app is served
Allowed origins for CORS
This container serves both the frontend and the backend, but you can run them as separate containers (will need CORS configuration).

docker pull manulera/opencloning
docker run -p 8000:8000 manulera/opencloning

Running an instance in GitHub Codespaces¶

Click the menu at the top left of the github website, then click codespaces
On the top-right click on New codespace
On Repository select manulera/OpenCloning
Click on Create codespace
In the terminal enter docker-compose up
Once complete a popup will appear saying port 8000 is now available, click Open in Browser to navigate to your own version of the OpenCloning app
Optional: To share with other users, navigate to the ports tab of the github codespace and right click and change port visibility to public

Running it yourself and configuration¶

If you want to run a dev server locally, or run the site without using docker, you can see how to set up the backend and frontend in their respective repositories:

Backend¶

The code of the backend is here: https://github.com/manulera/OpenCloning_backend

The backend is a web API built with FastAPI. For information on what it does, and how to install it and what it does see this.

Frontend¶

The code of the frontend is here: https://github.com/manulera/OpenCloning_frontend

The frontend application is built with react, and it is the "family tree builder" that you will see in your browser. For more info on what it does and how to install it see this