C a d H u b

Let's help Code-CAD reach its full potential! We're making a cadhub for the Code-CAD community, think of it as model-repository crossed with a live editor. We have integrations in progress for OpenSCAD and CadQuery with more coming soon.

If you want to be involved in anyway, checkout the Road Map and get in touch via, twitter, discord or discussions.

Getting your dev environment setup

git clone git@github.com:Irev-Dev/cadhub.git
# or
git clone https://github.com/Irev-Dev/cadhub.git

cd in the app directory

cd app

Install dependencies

yarn install

Setting up the db, you'll need to have a postgres installed locally, you can follow this guide.

Run the following

yarn rw prisma migrate dev
yarn rw prisma db seed

p.s. yarn rw prisma studio spins up an app to inspect the db

Fire up dev

yarn rw dev

Your browser should open automatically to http://localhost:8910 to see the web app. Lambda functions run on http://localhost:8911 and are also proxied to http://localhost:8910/.redwood/functions/*.

If you want to access the websight on your phone use yarn redwood dev --fwd="--host <ip-address-on-your-network-i.e.-192.168.0.5">"

you can sign in to the following accounts locally

localUser1@kurthutten.com: abc123

localUser2@kurthutten.com: abc123

localAdmin@kurthutten.com: abc123

You may need to register a account depending on what issue you are trying to tackle, This can be done by clicking the login button on the top right. This will open up netlify's idenitiy modal asking for the websites url, since it will notice you developing locally. Enter https://cadhub.xyz/ than use you email, verify your email and you should be set. (some routes are protected, but permissions is a big area that needs a lot of work in the near future, so it's in a very incomplete state atm)

Note:

We're using RedwoodJS, this is perhaps unwise since they haven't reached 1.0 yet, however with their aim to release 1.0 by the end of the year, it shouldn't be too difficult to port changes over the coming months. If you not familiar with Redwood, never fear the main bit of tech it uses is React, Graphql(apollo) and serverless/lamdas, depending on what part of the app you want to help with, so long as you know you way around these bits of tech you should be fine with some light referencing of the RedWood docs

Extra Redwood docs, i.e. getting familiar with the frame work.

• Tutorial: getting started and complete overview guide.
• Docs: using the Redwood Router, handling assets and files, list of command-line tools, and more.
• Redwood Community: get help, share tips and tricks, and collaborate on everything about RedwoodJS.

Styles

We're using tailwind utility classes so please try and use them as much as possible. Again if you not familiar, the tailwind search is fantastic, so searching for the css property you want to use will lead you to the correct class 99% of the time.

Designs

In progress, though can be seen on Figma

Integrations

The OpenSCAD and CadQuery integrations work by leveraging each of their cli tools in a docker image. It's currently deployed to AWS and can be found here.

Docs

Docs are hosted at learn.cadhub.xyz. It includes a OpenSCAD tutorial at this point, and more is coming. The docs can be found in this repo at docs

Who is CadHub

Kurt and Frank make up the Core-team and Jeremy is a major contributor. Plus a number smaller contributors.