CSC - Catalog of Second Chances

The Catalog of Second Chances (CSC) is a prototypical digital component database. It catalogs digital representations of uniquely identifiable architectural components for reuse. Furthermore, it provides corresponding interfaces and tools to leverage them via a backend REST-API, a web-frontend as well as a interface for direct interaction within Rhino Grasshopper.

Prerequisites

This is research level code! As always: expect bugs, weird behaviour, things not working, etc. pp.
This is a proof-of-concept / prototype. Things will change (and break) all the time.

Software Structure

The Catalog consists of a database, backend, frontend, and Grasshopper interface
We use MongoDB Atlas as database
The backend is implemented using FastAPI
We use Python 3.9.18
The frontend is implemented using the Next.JS framework
The frontend is designed to connect to the backend on the same server using JWT-based auth
Grasshopper interface provides Python 3 components for direct integration with Rhino/Grasshopper
Everything runs on a web server, in our case we use Uberspace

Current Versions

CSC FastAPI Backend: 0.4.7.0
CSC React Frontend: 0.4.7.0
CSC Grasshopper Interface: 0.4.5.6

Installation & Configuration

Start by cloning this repo onto your desktop computer.

MongoDB

Either create a MongoDB atlas account and set up a new database or run a MongoDB database by other means. You will need the full connection string in the form mongodb+srv://user:password@host/dbname.

Creating a Secret Key for JWT Auth

Open a terminal and run the following command to create a random secret key that will be used to sign JWT access tokens while authenticating with the FastAPI backend:

$ openssl rand -hex 32

>> 09d25e094faa6ca2556c818166b7a9563b93f7099f6f0f4caa6cf63b88e8d3e7

You will end up with a key like the above (DO NOT use the one in this example!).
If in doubt, have a look here for a detailed explanation of the auth setup: [FastAPI OAuth2 with Password (and hashing), Bearer with JWT tokens] (https://fastapi.tiangolo.com/tutorial/security/oauth2-jwt/#handle-jwt-tokens)

Setting up Environment Variables

All secrets and configuration are passed via environment variables — no config files with credentials are used in the backend.

Backend environment variables

The backend reads all configuration from the environment at startup and will exit immediately with a clear error listing any missing variables. There are two places you need to set them:

1. ~/.bash_profile — for shell scripts and cron jobs (see uberspaceconfig/.bash_profile.example for the full template):

export MONGODB_URI="mongodb+srv://user:password@host/csc"
export JWT_SECRET="your-openssl-rand-hex-32-value"
export JWT_ALGORITHM="HS256"
export JWT_ACCESS_TOKEN_EXPIRE_MINUTES="60"
export GITHUB_REPO_URL="https://github.com/your-org/your-repo"
export GITHUB_CSC_GH_TOKEN="ghp_xxxxxxxxxxxxxxxxxxxx"
export SMTP_HOST="yourhost.uberspace.de"
export SMTP_PORT="587"
export SMTP_USER="noreply@ddu.uber.space"
export SMTP_PASSWORD="your-mailbox-password"
export SMTP_FROM_EMAIL="noreply@ddu.uber.space"
export SMTP_FROM_NAME="Catalog of Second Chances"
export SMTP_DEV_MODE="false"
export FRONTEND_URL="https://ddu.uber.space"
export PREVIEW_DIR="/home/ddu/csc/backend/static/previews"
export GEOMETRY_DIR="/home/ddu/csc/backend/static/geometry"
export GEOMETRY_ARCHIVE_DIR="/home/ddu/csc/backend/static/geometry_archive"
export GH_XML_CACHE_DIR="/home/ddu/csc/backend/static/ghxml"
export FASTAPI_CORS_ORIGINS="https://ddu.uber.space,http://localhost:3000"

Apply immediately by running: source ~/.bash_profile

2. ~/etc/services.d/fastapi.ini — for the supervisord-managed FastAPI service (supervisord does not read ~/.bash_profile). Copy uberspaceconfig/etc/services.d/fastapi.ini.example to the server, fill in the real values in the environment= block, and keep it off git (it is gitignored; only the .example file is tracked).

Frontend environment variables

Navigate to ...\csc\src\frontend
Copy .env.example and rename it to .env
Edit .env and fill in the values following the comments in the file
Proceed in the same way with copying .env.local.example and renaming it to .env.local
Paste your JWT secret key into both the NEXTAUTH_SECRET and API_SECRET fields. This is odd but unfortunately necessary.
Add your MongoDB credentials so that the frontend can directly authenticate with MongoDB
Set NEXT_PUBLIC_STATIC_BASE_URL to a URL served directly by Apache (e.g. https://username.uberspace.de). On Uberspace, Next.js runs behind a reverse proxy and serving large static files (previews, downloads) through it causes 502 timeouts. This variable redirects those requests to Apache directly. It is ignored on localhost.

Grasshopper Interface Setup

The CSC Grasshopper Interface consists of Python 3 components that can be used directly in Grasshopper:

Location: grasshopper_userobjects_src/ - Source files for development
Installation: Copy .ghuser files from grasshopper_userobjects/ to your Grasshopper UserObjects folder
Requirements: Python 3 with packages: requests, numpy, scipy, scikit-learn
Authentication: Use CSC_SignIn component first to authenticate with the backend

Configuring Uberspace

If you want to setup CSC on Uberspace, here are some guidelines. Please also check the Uberlab Guides for further / more detailed information on the covered topics.

Create a folder for running CSC and a virtual environment on your uberspace server.

[user@servername ~]$ mkdir ~/csc
[user@servername ~]$ cd ~/csc
[user@servername csc]$ python3.9 -m venv venv
[user@servername csc]$ source venv/bin/activate
(venv) [user@servername ~]$

Install necessary packages and then deactivate the venv

(venv) [user@servername csc]$ pip install -r ~/csc/backend/requirements.txt
(venv) [user@servername csc]$ deactivate
[user@servername ~]$

Uploading files

Use a file transfer software to upload the backend and frontend folders to your web server. In our case the folder structure looks like this:

/home/user/
├─ csc/
│  ├─ venv/
│  ├─ backend/
│  ├─ frontend/

After the initial upload, make sure the logsdirectory in backend exists...

/home/user/
├─ csc/
│  ├─ venv/
│  ├─ backend/
│  │  ├─ ...
│  │  ├─ logs/
│  │  ├─ ...
│  ├─ frontend/

...or create it manually:

mkdir -p ~/csc/backend/logs

The deployment scripts (csc_deploy.sh, csc_deploy_backend.sh) handle this automatically on subsequent deploys.

Setting up FastAPI

We provide a pre-configured configuration file for gunicorn. Test if everything is working by running:

[user@servername ~]$ ~/csc/venv/bin/gunicorn --config ~/csc/backend/conf.py --check-config

If there is no output, you should be good. For additional info on setting up FastAPI on Uberspace, please check Uberlab.

Setting up the Next.js based React Frontend

The frontend runs using Next.js, which is a frontend framework based on React. All that runs using Node.js. First off, we check our node version. This repo assumes we run version 18:

[user@servername ~]$ uberspace tools version show node
Using 'Node.js' version: '18'
[user@servername ~]$

Once that is checked, navigate to /home/user/csc/frontend and run the following commands:

npm install -g npm@latest

removed 2 packages, and changed 53 packages in 9s

24 packages are looking for funding
[user@servername frontend]$ npm i
up to date, audited 482 packages in 4s
[user@servername frontend]$

This should install all necessary packages using the node package manager (npm). Once that is done, run:

[user@servername frontend]$ npm run build

> frontend@0.2.0.9 build
> next build

   ▲ Next.js 15.5.0
   - Environments: .env.local

   Creating an optimized production build ...
   ✓ Linting and checking validity of types
   ✓ Collecting page data
   ✓ Generating static pages (8/8)
   ✓ Collecting build traces
   ✓ Finalizing page optimization

Route (app)                              Size     First Load JS
┌ ○ /                                    141 B          84.5 kB
├ ○ /_not-found                          882 B          85.2 kB
├ λ /components                          244 kB          346 kB
├ λ /components/[component_id]           816 B          91.9 kB
├ ○ /findcomponent                       111 kB          203 kB
└ ○ /settings                            141 B          84.5 kB
+ First Load JS shared by all            84.4 kB
  ├ chunks/69-9d1319c8f23893a2.js        29 kB
  ├ chunks/fd9d1056-7473a1f6941f0e46.js  53.4 kB
  └ other shared chunks (total)          1.97 kB


○  (Static)   prerendered as static content
λ  (Dynamic)  server-rendered on demand using Node.js

[user@servername frontend]$

Now you should be almost set up! The last things to do are configuring services and corresponding web backends...

Upgrading Next.js

Use the official Next.js codemod to upgrade the frontend to a newer version:

# Upgrade to the latest patch (e.g. 16.0.7 -> 16.0.8)
npx @next/codemod upgrade patch

# Upgrade to the latest minor (e.g. 15.3.7 -> 15.4.8). This is the default.
npx @next/codemod upgrade minor

# Upgrade to the latest major (e.g. 15.5.7 -> 16.0.7)
npx @next/codemod upgrade major

# Upgrade to a specific version
npx @next/codemod upgrade 16

# Upgrade to the canary release
npx @next/codemod upgrade canary

Services Config using Supervisor

Again, we will consider our setup case using Uberspace, which uses Supervisor for services:

On your computer, navigate to ...\csc\uberspaceconfig\etc\services.d
This folder contains two configuration files for Supervisor
For fastapi.ini: use fastapi.ini.example as a template, fill in the real values in the environment= block, and transfer your filled-in copy to the server — never commit the file with real secrets (it is gitignored)
For react-frontend.ini: transfer as-is, no user-specific values needed. It only sets NODE_ENV=production; all frontend configuration is baked in at build time via .env.
Transfer the files to Uberspace into /home/yourusername/etc/services.d
Run the following commands:

[user@servername ~]$ supervisorctl reread
SERVICE: available
[user@servername ~]$ supervisorctl update
SERVICE: added process group
[user@servername ~]$ supervisorctl status
SERVICE                            RUNNING   pid 26020, uptime 0:03:14

Configuring Web Backends

Gunicorn is set up to run the FastAPI backend on Port 8000
The Next.js frontend is configured to run on Port 3000
The Web Backends have to be set to the port that the apps are listening on!
First, we list the active backends:

[user@servername ~]$ uberspace web backend list
/ apache (default)
[user@servername ~]$

We will not use the default backend, so we delete it

[user@servername ~]$ uberspace web backend del /
The web backend has been deleted.
[user@servername ~]$

Next we register a subdomain for our FastAPI backend...

[user@servername ~]$ uberspace web domain add api.username.uber.space
The webserver's configuration has been adapted.
Now you can use the following records for your DNS:
    A -> 185.26.156.55
    AAAA -> 2a00:d0c0:200:0:b9:1a:9c:37
[user@servername ~]$

Then we add the corresponding web backend for FastAPI

[user@servername ~]$ uberspace web backend set api.username.uber.space/ --http --port 8000
Set backend for api.username.uber.space/ to port 8000; please make sure something is listening!
You can always check the status of your backend using "uberspace web backend list".
[user@servername ~]$

Lastly, we set our default backend to point to the Next.js...

[user@servername ~]$ uberspace web backend set / --http --port 3000
Set backend for / to port 3000; please make sure something is listening!
You can always check the status of your backend using "uberspace web backend list".
[user@servername ~]$

For further information please refer to the corresponding Uberspace manual and Uberlab guides:

Deploying .htaccess

The repo contains uberspaceconfig/html/.htaccess which must be placed at ~/html/.htaccess on the server. It sets CORS headers for the Apache layer and forces .wsc files to download as application/octet-stream rather than being served inline. Without it, Grasshopper component downloads will not work correctly.

[user@servername ~]$ cp ~/csc/uberspaceconfig/html/.htaccess ~/html/.htaccess

Before deploying, update the Access-Control-Allow-Origin header in the file to match your actual frontend domain.

Preview Generation CronJob

Preview generation is a separate python app that is run using a cronjob. To test the preview generation, SSH into the server, activate the venv and run it using the command line:

[user@servername csc]$ source venv/bin/activate
(venv) [user@servername ~]$
(venv) [user@servername ~]$ python /home/ddu/csc/backend/main_previewgen.py

To check if it is already a cronjob on your instance, run:

[user@servername csc]$ crontab -l

To add the cronjob to your crontab run:

[user@servername csc]$ crontab -e

...to open the crontab in an editor and then add:

*/30 * * * * source /home/ddu/.bash_profile && /home/ddu/csc/venv/bin/python3.9 /home/ddu/csc/backend/main_previewgen.py >> /home/ddu/csc/backend/logs/previewgen_cronjob.log 2>&1

This will run the preview generation script every 30 minutes and write the results to a logging file. The source ~/.bash_profile prefix is required so that the cron job picks up the environment variables.

Grasshopper XML Sync CronJob

The GH XML sync automatically mirrors pasteable XML files from the private GitHub repository to make them available for copy-to-clipboard functionality on the frontend.

Configuration

The script reads GITHUB_REPO_URL, GITHUB_CSC_GH_TOKEN, and GH_XML_CACHE_DIR from the environment. Make sure these are set in ~/.bash_profile (see the environment variables section above).

Testing

To test the sync script manually, SSH into the server and run:

[user@servername csc]$ /bin/bash /home/ddu/csc/src/backend/ghxml_sync.sh

This will clone (if needed) and sync only the grasshopper_userobjects_xml/ folder from your private GitHub repository. Check the log file for results:

[user@servername csc]$ tail -f /home/ddu/csc/backend/logs/ghxml_sync.log

Setting up the CronJob

To add the sync cronjob, copy the configuration from uberspaceconfig/crontab/ghxml_sync_cronjob.ini or add it manually:

[user@servername csc]$ crontab -e

Add this line:

*/30 * * * * source /home/ddu/.bash_profile && /bin/bash /home/ddu/csc/backend/ghxml_sync.sh >> /home/ddu/csc/backend/logs/ghxml_sync.log 2>&1

This will run the sync every 30 minutes and log results to the log file.

User Maintenance CronJob

Removes unverified user accounts older than 7 days. Runs daily at 2:00 AM.

0 2 * * * source /home/ddu/.bash_profile && /home/ddu/csc/venv/bin/python3.9 /home/ddu/csc/backend/usermaintenance.py >> /home/ddu/csc/backend/logs/usermaintenance_cronjob.log 2>&1

Geometry Maintenance CronJob

Removes geometry subdirectories that have no corresponding component in the database. Runs daily at 3:00 AM.

0 3 * * * source /home/ddu/.bash_profile && /home/ddu/csc/venv/bin/python3.9 /home/ddu/csc/backend/geometrymaintenance.py >> /home/ddu/csc/backend/logs/geometrymaintenance_cronjob.log 2>&1

Descriptor Computation CronJob

Computes missing descriptors for components. Runs every 2 minutes; uses flock to prevent overlapping runs.

*/2 * * * * source /home/ddu/.bash_profile && flock /home/ddu/csc/venv/bin/python3.9 /home/ddu/csc/backend/main_descriptors_simple.py >> /home/ddu/csc/backend/logs/descriptors_simple_cronjob.log 2>&1

Ready-made crontab entries for all jobs are in uberspaceconfig/crontab/.

Deployment

Two deployment scripts are provided in uberspaceconfig/deployment/. Both require GITHUB_DEPLOY_URL to be set in ~/.bash_profile.

csc_deploy.sh — full deploy: pulls backend + frontend, restarts backend, rebuilds and restarts frontend
csc_deploy_backend.sh — backend only: pulls backend, restarts FastAPI

OpenAPI Model Generation

This project uses OpenAPI schema generation to keep frontend TypeScript models in sync with backend Pydantic models.

How It Works

Backend: Pydantic models are enhanced with OpenAPI documentation and Field descriptions
Schema Endpoint: /schema/component endpoint exposes the ComponentModel schema
Frontend Generation: Script fetches schema and generates TypeScript interfaces
Auto-sync: Models are automatically kept in sync

Usage

Generate Models

# Generate data models from backend
npm run generate:models

Development Workflow

Update Backend Model: Modify Pydantic model in src/backend/apps/Catalog/models.py
Restart Backend: Restart FastAPI to regenerate OpenAPI schema
Generate Frontend Models: Run npm run generate:models
Use Generated Models: Import from src/generated/ComponentModel

Import Generated Models

// Instead of importing from components/common/models
// import { ComponentData } from '@/components/common/models';

// Import from generated models
import { ComponentModel, ComponentType, ComponentComplexity } from '@/generated/ComponentModel';

// Use the generated interface
const component: ComponentModel = {
  _id: "uuid",
  type: "slab",
  material: "concrete",
  // ... other properties
};

File Structure

src/frontend/
├── scripts/
│   └── generate-models.ts    # Generation script
├── generated/                 # Auto-generated models
│   ├── ComponentModel.ts     # Generated ComponentModel interface
│   └── index.ts             # Export index
└── package.json              # Contains generate:models script

Testing

To run all available tests, call

invoke test

Linting

To lint all python code, call

invoke lint

Credits

Public Funding

Part of this research was conducted within the Project Fertigteil 2.0 - Real-digital process chains for the production of built-in concrete components. The project Fertigteil 2.0 (Precast Concrete Components 2.0) was funded by the Federal Ministry of Education and Research Germany (BMBF) through the funding measure "Resource-efficient circular economy - Building and mineral cycles (ReMin)".

Part of this research was conducted within the Project ZirKuS - Circular Construction and Structural Design of Reused Concrete Components. The project ZirKuS is funded by the Deutsche Bundesstiftung Umwelt DBU (German Federal Environmental Foundation) within the funding line "Climate- and Resource-Efficient Construction."

Student Work

The csc_labels python code to create QR-Code labels was developed by Mirko Dutschke. The code has been refactored as a python module and integrated by Max Benjamin Eschenbach.
The csc_sheetscan python module was developed based on the scanning setup for sheets that was developed by Mirko Dutschke. The functional code has been written by Max Benjamin Eschenbach.
NEW: The CSC Grasshopper Interface components were developed and standardized by Max Benjamin Eschenbach, providing Python 3 components for direct integration with Rhino/Grasshopper workflows.

Licensing

Original code is licensed under the MIT License.
The csc_sheetscan module makes heavy use of the OpenCV library, more specifically its pre-built packages for python via conda-forge.

References

The technical main inspiration for the Catalog of Second Chances interface is the Catalog Explorer by @AymbericBr.
Another huge inspiration and reference is the Timberstone Project, which is the origin of abovementioned Catalog Explorer.

Citing

When using, extending or building upon this piece of softare in your work, please reference it accordingly:

BibTex

@software{eschenbach_2026_20156667,
  author       = {Eschenbach, Max Benjamin},
  title        = {Catalog of Second Chances (CSC) - Digital Database
                   and Corresponding Interfaces for ReUse of
                   Architectural Components
                  },
  month        = may,
  year         = 2026,
  publisher    = {Zenodo},
  doi          = {10.5281/zenodo.20156666},
  abstract = {The Catalog of Second Chances (CSC) provides a prototypical platform and the corresponding tools to leverage a database of uniquely identified, digitized architectural components for creating designs that reuse these components.},
  url          = {https://doi.org/10.5281/zenodo.20156666},
}

Other Citation Styles

Find pre-written citations in the style of your choice over at Zenodo (Citation box on the right side).

Name		Name	Last commit message	Last commit date
Latest commit History 875 Commits
.github/workflows		.github/workflows
charts		charts
grasshopper_development		grasshopper_development
grasshopper_release		grasshopper_release
grasshopper_userobjects		grasshopper_userobjects
grasshopper_userobjects_src		grasshopper_userobjects_src
grasshopper_userobjects_src_deprecated		grasshopper_userobjects_src_deprecated
grasshopper_userobjects_xml		grasshopper_userobjects_xml
licenses		licenses
resources		resources
scripts		scripts
src		src
tests/csc_sheetscan/utilities		tests/csc_sheetscan/utilities
tutorial		tutorial
uberspaceconfig		uberspaceconfig
.cursorignore		.cursorignore
.gitattributes		.gitattributes
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
LICENSE		LICENSE
README.md		README.md
csc.code-workspace		csc.code-workspace
csc_env.yml		csc_env.yml
tasks.py		tasks.py

Folders and files

Latest commit

History

Repository files navigation

CSC - Catalog of Second Chances

Prerequisites

Software Structure

Current Versions

Installation & Configuration

MongoDB

Creating a Secret Key for JWT Auth

Setting up Environment Variables

Backend environment variables

Frontend environment variables

Grasshopper Interface Setup

Configuring Uberspace

Uploading files

Setting up FastAPI

Setting up the Next.js based React Frontend

Upgrading Next.js

Services Config using Supervisor

Configuring Web Backends

Deploying .htaccess

Preview Generation CronJob

Grasshopper XML Sync CronJob

Configuration

Testing

Setting up the CronJob

User Maintenance CronJob

Geometry Maintenance CronJob

Descriptor Computation CronJob

Deployment

OpenAPI Model Generation

How It Works

Usage

Generate Models

Development Workflow

Import Generated Models

File Structure

Testing

Linting

Credits

Public Funding

Student Work

Licensing

References

Citing

BibTex

Other Citation Styles

To-Do & Extension Ideas

About

Topics

Resources

License

Code of conduct

Uh oh!

Stars

Watchers

Forks

Releases 3

Packages 0

Uh oh!

Uh oh!

Contributors

Uh oh!

Languages

Packages