-
-
Notifications
You must be signed in to change notification settings - Fork 46
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added info on how to build the studio
- Loading branch information
Showing
1 changed file
with
30 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |