Archiyou-core

🌐 What is Archiyou?

Archiyou is an online platform to codify design and making know-how. It is freely available to try. See Archiyou.com.

Quickstart: Run you own scripts standalone [WIP]

To use Archiyou as a module to generate designs and documentation independently from our platform it's available as module on npm.

    import { Runner } from 'archiyou'
    // A runner executes Archiyou scripts
    const runner = new Runner()

    // First a Runner needs to load (because it uses WASM)
    runner.load().then(async (runner) => 
    {
         // Then you execute a script in the default scope
         const r = await runner.execute({ 
                     code: `b = new Box($SIZE)`, 
                     params: { SIZE: 100 } }, 
                     { formats: ['glb'] }
                  ); 
         const glb = r?.meshGLB; // The 3D model mesh in GLB format (default)
         console.log(`Generating a GLB box took: ${r.duration} ms`);
    });

Check out the starter-templates directory examples how to use Archiyou in the context of popular JS/TS frameworks like Nuxt, Next and React.

🚩 What is Archiyou-core?

This is the core library of the Archiyou platform. It consists of the following parts:

• 🛠️ Geom - The module to create geometry and topology shapes. Wraps a custom build of OpenCascade.js.
• 📦 Exporter - Module to export data
• ☝ Importer (IO) - Module in-progress to import data from different sources like SVG's, geodata etc.
• ⭐ Annotator - A module for generating annotations like dimension lines and labels
• 📚 Doc - The module to define documents, pages and add content (shapes, text, images) to them
• 🌈 Misc utils - A way to parse scripts in different scopes (like Webworkers)

This repository also contains:

• 📄 Documentation - Containing all VuePress documentation at docs.archiyou.com
• ⏰ Unit tests - Very basic tests of the core functionality based on Jest (see /tests/)

💙 Open Source Core

Archiyou would not exist without great open source software: geometry kernel OpenCascade, OpenCascade.js, CadQuery and many others.

That's why we want to keep the core of Archiyou open. This has some advantages:

• CAD content created on the Archiyou platform is always portable and can be used without Archiyou. Never a vendor lock-in!
• Open source CAD based on OpenCascade kernel like FreeCAD, CadQuery, ZenCAD, RepliCAD and now Archiyou can work together to challenge the proprietary CAD systems. For maximum adoption and compatibility with CadQuery we chose the Apache2 License

Currently the source code of the platform itself (the frontend app and server infrastructure) remains closed but parts of it become open source in collaborations like OCCI.

🏗 What is the state of Archiyou-core?

We are building the Archiyou platform, its content and the core at the same time. This means some parts are pretty robust while others might be experimental still.

🚀 Getting started

• To see how Archiyou works: Archiyou.com
• To start making some models yourself: editor.archiyou.com
• To use the archiyou-core for your own apps: Check out npm module and starter-templates

🙋 Contributions

We love to get contributions. For example:

• Bug reports and fixes
• Documentation and examples for docs.archiyou.com
• Community organizing: workshops for example
• Open design content: make content and share it on the Archiyou platform or OCCI for others

🙏 Collaborations and recommended projects

• Open CAD Components Interface (OCCI) - Publish your CAD scripts as parametric CAD components (with CadQuery team and OTF)

Other great projects that might suit your needs:

• CadQuery - Python based Script CAD and inspiration for Archiyou
• OpenCascade.js - Run a CAD kernel directly in your browser. Without the great work by Sebastian on porting the OpenCascade kernel to WASM Archiyou would not exist
• Replicad - Great script CAD library by Steve based on the same technology as Archiyou. Generally more focussed on developers.

🙌 License

Archiyou-core is licensed under the terms of the Apache Public License, version 2.0.

Developer Notes

More developer guides are coming!

Basics

yarn
yarn dev
yarn build
yarn test
yarn apidocs

• To avoid TS errors on OC.js libs: Add // @ts-nocheck to archiyou-opencascade.d.ts

Special builds:

• Standalone TypeDocs: npx typedoc (in ./docs/src/.vuepress/dist/apidocs - so we can combine with VuePress docs)
• TS compilation testing: npx tsc -t es5 --experimentalDecorators --esModuleInterop --noEmit geom.ts
• TS compile *.d.ts for Intellisense: npx tsc -t es5 --experimentalDecorators --esModuleInterop -d --outDir ".\d\d.ts" --emitDeclarationOnly geom.ts

Testing

yarn test
yarn test --silent

Building as module

[WIP] We use Vite to compile and bundle the library as a ES module. See vite.config.ts.

# run module build
yarn build

Linking locally

yarn build
npm link
# then at app that uses module
npm link archiyou-core

NOTES: Currently we still use the emscripting glue JS (both for browser and Node) - Thats why we have added ./wasm directory to package.json > files