Update README.md
This commit is contained in:
Kurt Hutten
GitHub
75
README.md
75
README.md
@@ -8,80 +8,9 @@
|
|||||||
|
|
||||||
Let's help Code-CAD reach its [full potential!](https://cadhub.xyz) We're making a ~~cad~~hub for the Code-CAD community, think of it as model-repository crossed with a live editor. We have integrations in progress for [OpenSCAD](https://cadhub.xyz/dev-ide/openscad) and [CadQuery](https://cadhub.xyz/dev-ide/cadquery) with [more coming soon](https://github.com/Irev-Dev/curated-code-cad).
|
Let's help Code-CAD reach its [full potential!](https://cadhub.xyz) We're making a ~~cad~~hub for the Code-CAD community, think of it as model-repository crossed with a live editor. We have integrations in progress for [OpenSCAD](https://cadhub.xyz/dev-ide/openscad) and [CadQuery](https://cadhub.xyz/dev-ide/cadquery) with [more coming soon](https://github.com/Irev-Dev/curated-code-cad).
|
||||||
|
|
||||||
If you want to be involved in anyway, checkout the [Road Map](https://github.com/Irev-Dev/cadhub/discussions/212) and get in touch via, [twitter](https://twitter.com/IrevDev), [discord](https://discord.gg/SD7zFRNjGH) or [discussions](https://github.com/Irev-Dev/cadhub/discussions).
|
If you want to be involved in anyway, checkout the [contributing.md](https://github.com/Irev-Dev/cadhub/blob/main/CONTRIBUTING.md).
|
||||||
|
|
||||||
## Getting your dev environment setup
|
|
||||||
|
|
||||||
|
|
||||||
```terminal
|
|
||||||
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
|
|
||||||
```terminal
|
|
||||||
yarn install
|
|
||||||
```
|
|
||||||
|
|
||||||
Setting up the db, you'll need to have a postgres installed locally, you can [follow this guide](https://redwoodjs.com/docs/local-postgres-setup).
|
|
||||||
|
|
||||||
Run the following
|
|
||||||
``` terminal
|
|
||||||
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
|
|
||||||
```terminal
|
|
||||||
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](https://redwoodjs.com/), 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](https://redwoodjs.com/tutorial/welcome-to-redwood): getting started and complete overview guide.
|
|
||||||
- [Docs](https://redwoodjs.com/docs/introduction): using the Redwood Router, handling assets and files, list of command-line tools, and more.
|
|
||||||
- [Redwood Community](https://community.redwoodjs.com): 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](https://tailwindcss.com/) 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](https://www.figma.com/file/VUh53RdncjZ7NuFYj0RGB9/CadHub?node-id=0%3A1)
|
|
||||||
|
|
||||||
## 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](https://github.com/Irev-Dev/cadhub/tree/main/app/api/src/docker). JSCAD integration runs directly in the browser.
|
|
||||||
|
|
||||||
## Docs
|
|
||||||
Docs are hosted at [learn.cadhub.xyz](http://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](https://github.com/Irev-Dev/cadhub/tree/main/docs)
|
|
||||||
|
|
||||||
|
you might also be interested in the [Road Map](https://github.com/Irev-Dev/cadhub/discussions/212) and getting in touch via, [twitter](https://twitter.com/IrevDev), [discord](https://discord.gg/SD7zFRNjGH) or [discussions](https://github.com/Irev-Dev/cadhub/discussions).
|
||||||
|
|
||||||
## Who is CadHub
|
## Who is CadHub
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user