Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ronzim committed Jan 10, 2024
1 parent d6f1478 commit e4be5fa
Show file tree
Hide file tree
Showing 3 changed files with 6,135 additions and 56 deletions.
File renamed without changes.
67 changes: 11 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,67 +1,27 @@
## See it
A customizable application built on three.js that allows users to design an interior space such as a home or apartment.

This repository includes an example application built using blueprint3d:
Forked from: https://github.com/furnishup/blueprint3d

### http://furnishup.github.io/blueprint3d/example/
## Online Demo

## What is this?

This is a customizable application built on three.js that allows users to design an interior space such as a home or apartment. Below are screenshots from our Example App (link above).

1) Create 2D floorplan:

![floorplan](https://s3.amazonaws.com/furnishup/floorplan.png)

2) Add items:

![add_items](https://s3.amazonaws.com/furnishup/add_items.png)

3) Design in 3D:

![3d_design](https://s3.amazonaws.com/furnishup/design.png)
https://ronzim.github.io/blueprint3d/

## Developing and Running Locally

To get started, clone the repository and ensure you npm >= 3 and grunt installed, then run:

npm install
grunt
npm run dev

The latter command generates `example/js/blueprint3d.js` from `src`.

The easiest way to run locally is to run a local server from the `example` directory. There are plenty of options. One uses Python's built in webserver:

cd example

# Python 2.x
python -m SimpleHTTPServer
The easiest way to run locally is to run a local server from the `example` directory, eg using `VS Code Live Server` extension.

# Python 3.x
python -m http.server
## Todo list

Then, visit `http://localhost:8000` in your browser.

## Contribute!

This project requires a lot more work. In general, it was rushed through various prototype stages, and never refactored as much as it probably should be. We need your help!

Please contact us if you are interested in contributing.

### Todos

- More complete documentation (based on the TypeDoc comments)
- Test suite (e.g. jasmine)
- Make it easier to build a complete application using blueprint3d (cleaner API, more inclusive base, easier integration with a backend)
- Better serialization format for saving/loading "designs"
- Remove the dependency on jquery from the core source!
- Better use of npm conventions and packaging
- Various bug fixes
- refactor three/* - use of classes, lambdas
- update to current threejs
- introduce a more formal persistency format
- put all relevant settings into Core.Configuration to make them read-/writeable, User settings?
- complete type docs for all entities
- there're a few TODO_Ekki's left, kill them all
- [ ] dependencies update
- [ ] remove jquery dependency
- [ ] remove grunt in favour of a better dev experience

## Directory Structure

Expand All @@ -79,11 +39,6 @@ The `src` directory contains the core of the project. Here is a description of t

`three` - 3D view/controller for viewing and modifying item placement


### `example/` Directory

The example directory contains an application built using the core blueprint3d javascript building blocks. It adds html, css, models, textures, and more javascript to tie everything together.

## License

This project is open-source! See LICENSE.txt for more information.
The example directory contains an application built using the core blueprint3d javascript building blocks. It adds html, css, models, textures, and more javascript to tie everything together. Copied in `/docs` directory for gh pages.
Loading

0 comments on commit e4be5fa

Please sign in to comment.