Skip to content

Commit

Permalink
Added info on how to build the studio
Browse files Browse the repository at this point in the history
  • Loading branch information
sgenoud committed Sep 27, 2024
1 parent ee4a06d commit fc4244f
Showing 1 changed file with 30 additions and 5 deletions.
35 changes: 30 additions & 5 deletions packages/studio/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,36 @@
# `studio`
## replicad studio

> TODO: description
This repo contains the code of the [replicad studio
website](studio.replicad.xyz).

## Usage
You can run it locall by cloning the repo and running (you can use another
package manager as well):

```bash
cp -r replicad/packages/studio my-studio
cd my-studio
npm install
```
const studio = require('studio');

// TODO: DEMONSTRATE API
You can then run it locally (for development purposes) with:

```
# in the my-studio directory
npm run start
```

You can also build it:

```bash
# in the my-studio directory
npm run build
```

The assets will be in the `dist` directory. You can serve them locally with:

```bash
npm run serve
```

But I would advise you to use a proper web server if you want to expose it to
the web (this is a pure static website).

0 comments on commit fc4244f

Please sign in to comment.