Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update documentation #14

Merged
merged 4 commits into from
Apr 4, 2024
Merged

update documentation #14

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fce26a9
adding more sources for 3D models
koebel Apr 4, 2024
4b3acd5
update build and run to make it more explicit
koebel Apr 4, 2024
36aaa1b
minor changes
koebel Apr 4, 2024
671c1fb
change order (docker after build & run)
koebel Apr 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

![3d model viewer ui](./docs/ss-light.png)

It is an extension for [ownCloud web](https://github.com/owncloud/web) for viewing 3D files. Currently, it can only open `.glb` file format.
This is an extension for [ownCloud web](https://github.com/owncloud/web) for viewing 3D files. Currently, it can only display 3D models in `.glb` file format.

## Feature Highlights ✨

Expand All @@ -20,9 +20,12 @@ Run the extension container with:
```bash
docker run --rm -p3000:80 sawjan/web-app-3dmodel-viewer
```
You can access the app at https://host.docker.internal:9200
Copy link
Owner

@saw-jan saw-jan Apr 4, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this would be wrong here because this section doesn't say about serving ocis.
What can be done here is, remove docker run example and only say which port does the image exposes. like this:

- Run the extension container with:
- ```bash
- docker run --rm -p3000:80 sawjan/web-app-3dmodel-viewer
- ```
+ Exposed port: `80`

This should prevent running docker run command.
Or, we can move this whole section to the buttom after Build and Run

Copy link
Contributor Author

@koebel koebel Apr 4, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like that idea of changing the order. I think that makes it clearer. And I guess for those who use Docker frequently, I guess the would see from the command that it is exposed at port 80


## Build and Run

For building and running the app from the code base, follow these steps:

1. Install the dependencies

```bash
Expand All @@ -47,6 +50,17 @@ docker run --rm -p3000:80 sawjan/web-app-3dmodel-viewer
docker compose up
```

Now, you can access the web at https://localhost:9200
Now, you can access the app at https://localhost:9200

## 3D models

The app currently only supports 3D models in `.glb` format. You can find models on the following platforms:

For 3D models: [sketchfab](https://sketchfab.com/) (Download the models in `.glb` format)
- [sketchfab](https://sketchfab.com/)
- [3Dexport](https://3dexport.com/free-3d-models)
- [archive3D](https://archive3d.net/)
- [clara.io](https://clara.io/library)
- [downloadfree3D](https://downloadfree3d.com/file-format/glb/)
- [free3D](https://free3d.com/)
- [sketchup](https://3dwarehouse.sketchup.com/)
- [turbosquid](https://www.turbosquid.com/Search/3D-Models/free)