Explore the sample project

Before you begin

Renku Studio is installed and its Project Library has been set up. You need Git and a terminal (Terminal on Mac or PowerShell on Windows).

What you’ll do

The Basilica sample appears on Studio’s Projects page, ready to explore.

Find your Project Library

Studio shows the folder it scans for projects at the top of the Projects page, beneath “Project Library.” Use that exact path. The usual location is ~/Movies/Renku on Mac or your Videos\Renku folder on Windows, but your setup may use a different folder.

1. Open Studio’s Projects page and copy or note the Project Library path shown at the top.
2. Open Terminal or PowerShell. Change to that folder, replacing the example path below with the path Studio shows. Keep the quotes if the path contains spaces.

cd "<Project Library path shown in Studio>"

Clone the sample

Clone the repository directly inside the Project Library. Git creates a sample-project folder; keep that folder name because the project database uses it.

1. Run the command below while your terminal is in the Project Library folder. The download includes media, so it may take a little time.

git clone https://github.com/GoRenku/sample-project.git

View the sample project on GitHub →

Open it in Studio

The Projects page discovers folders in your Project Library that contain a Renku project database. The sample repository already includes that database in sample-project/.renku/project.sqlite. The .renku folder may be hidden in your file browser; you do not need to edit it or create a new project in Studio.

1. Return to the Projects page and choose Refresh. Look for the card titled Basilica, with sample-project as its folder name.
2. Open Basilica and explore the screenplay, cast, locations, storyboards, and shot planning at your own pace.
3. If the card does not appear, check that sample-project is directly inside the path shown at the top of the Projects page, and that its .renku/project.sqlite file is present.