Kristaps Fabians Geikins
b6c21fd506
* webhooks perm minor fix * tryna get fileimport service to work * new comment policies - shared * BE done? * checks implemented in FE * lint fix * tests fix * readme fix
46 lines
1.4 KiB
Markdown
46 lines
1.4 KiB
Markdown
# File Import Service
|
|
|
|
## Description of how this works
|
|
|
|
A micro-service which polls a Postgres database table `file_uploads` for new records and processes them.
|
|
|
|
It retrieves a referenced file from an S3 bucket and stores it in a local directory for parsing.
|
|
|
|
The File Import service can parse either STL, OBJ, or IFC files using external packages, written in either .Net or Python (_note_, there is a legacy IFC parser written in Node.js). These external packages are controlled via shell commands.
|
|
|
|
The parsers are responsible for extracting the necessary data from the files and storing it in the database. They are also responsible for creating a new Speckle model if necessary.
|
|
|
|
The service is then responsible for updating the status of the `file_uploads` table, and for posting a Postgres notification.
|
|
|
|
## Dev setup
|
|
|
|
### Building/Running the .NET importer
|
|
|
|
Requirements:
|
|
|
|
- Ubuntu 24+
|
|
|
|
Do this on Ubuntu/OSX to install dotnet:
|
|
|
|
```bash
|
|
# Add microsoft package repo
|
|
sudo apt update && sudo apt install -y wget apt-transport-https
|
|
wget https://packages.microsoft.com/config/ubuntu/$(lsb_release -rs)/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
|
|
sudo dpkg -i packages-microsoft-prod.deb
|
|
|
|
# Install dotnet sdk 8
|
|
sudo apt update
|
|
sudo apt install -y dotnet-sdk-8.0
|
|
|
|
# Verify version
|
|
dotnet --version
|
|
```
|
|
|
|
Do this to build:
|
|
|
|
```bash
|
|
cd ./packages/fileimport-service/src/ifc-dotnet
|
|
|
|
dotnet publish ifc-converter.csproj -c Release -o output/
|
|
```
|