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

Jump to bottom

Added instructions to run the project. #4

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Added instructions to run the project. #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
675a742
Added instructions on how to run the project.
TheeAndre Nov 24, 2023
496cbc6
Updated gitignore
TheeAndre Nov 24, 2023
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
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,6 @@ npm-debug.log
*.png
.env
.DS_Store
package-lock.json
.gitignore
Copy link

Choose a reason for hiding this comment

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

why's gitignore in the gitignore?

package.json
Copy link

Choose a reason for hiding this comment

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

also, package.json and it's lock are good to be present, not gitignored

43 changes: 42 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,45 @@

A simple example showing how to setup a 3d scene across windows on the same origin using three.js and localStorage. Code should be self explanatory

follow me on twitter at [@_nonfigurativ_](https://twitter.com/_nonfigurativ_) for more stuff like this
follow me on twitter at [@_nonfigurativ_](https://twitter.com/_nonfigurativ_) for more stuff like this



## HOW TO RUN THE PROJECT

#### 1) Install http-server globaly:
-------------
Copy link

Choose a reason for hiding this comment

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

  • why adding a breakline after this H4 (4 #) ?
  • Why use H4 when above you have a H2 (2 #) ?


`sudo npm install http-server -g`
Copy link

Choose a reason for hiding this comment

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

why using sudo ? You can install "globally" for the user
ref:

Copy link

Choose a reason for hiding this comment

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

Or use npx?

Copy link

Choose a reason for hiding this comment

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

why not just use python
python -m http.server 6969



#### 2) Navigate to the project directory:
-------------

`cd multipleWindow3dScene`


#### 3) Start the local server:
-------------

`http-server`


#### 4) Open the project in your browser:
-------------

```
Starting up http-server, serving ./
Available on:
http://127.0.0.1:8080
http://10.0.0.227:8080
http://169.254.109.130:8080
Hit CTRL-C to stop the server
```

#### Online Preview

You can view the online preview from [this link](https://bgstaal.github.io/multipleWindow3dScene/):

https://bgstaal.github.io/multipleWindow3dScene/