opendetail

opendetail is a platform to share biophilic & low carbon details

Tech Stack

Client: React, Speckle, TypeScript

Server: ASP.NET Core Web API, Speckle Automate

Installation

Clone repository with Git.

Client

React app that runs using Vite

  cd client

  npm install

  npm run dev

API

Would recommend opening using Visual Studio Professional. The solution file can be found in the \server\ folder

API Reference

API documentation is generated by Swagger and will be visible when the API is running. Make sure this line is true in \Properties\LaunchSettings.json

"launchBrowser": true, //If true, will open Swagger in a browser

Running Tests (TODO)

Client

Unit tests are using Vitest and can be run with the following command.

  npm run test

API

Integration tests are using xUnit. You can open the test explorer in Visual Studio with CTRL + E + T. Then you can run all tests