Skip to content

Commit bf3b433

Browse files
committed
updated readme
1 parent 7805901 commit bf3b433

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Floorscape is an AI-assisted architectural visualization app that converts uploaded 2D floor plans into rendered top-down 3D interiors. The frontend is built with React Router 7, React 19, Vite, and Tailwind CSS v4, while authentication, file hosting, AI image generation, and project persistence are handled through Puter services.
44

5+
**Live demo:** https://floorscape.netlify.app/
6+
57
## Project Overview
68

79
The application is designed around a simple workflow:
@@ -17,6 +19,11 @@ The codebase includes both:
1719
- A React Router frontend for the user interface
1820
- A Puter worker script that exposes project persistence endpoints
1921

22+
## Preview
23+
24+
![Home page upload and projects](preview/preview-01.png)
25+
![Visualizer before/after comparison](preview/preview-02.png)
26+
2027
## Features
2128

2229
- Puter-based authentication
@@ -143,6 +150,10 @@ docker run -p 3000:3000 floorscape
143150
- `npm run start` serves the built app from `./build/server/index.js`
144151
- `npm run typecheck` runs route type generation and TypeScript checks
145152

153+
## Known Issues
154+
155+
- `npm run typecheck` currently fails at `app/routes/visualizer.$id.tsx:213` because `string | null | undefined` is passed to a prop expecting `string | undefined`.
156+
146157
## Folder Structure
147158

148159
```text

0 commit comments

Comments
 (0)