https://github.com/mehanix/arcada

📐 react & pixi.js interior design software / floor plan creator
https://github.com/mehanix/arcada

express expressjs floor-plan floor-plan-mapper floor-planning floorplan floorplan-construction good-first-pr good-first-project help-wanted javascript mantine mongodb mongoose nodejs pixijs react reactjs room-planner zustand

Last synced: 9 days ago
JSON representation

📐 react & pixi.js interior design software / floor plan creator

• Host: GitHub
• URL: https://github.com/mehanix/arcada
• Owner: mehanix
• License: apache-2.0
• Created: 2022-02-24T19:08:11.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-06-02T09:25:58.000Z (5 months ago)
• Last Synced: 2024-10-15T00:21:32.129Z (25 days ago)
• Topics: express, expressjs, floor-plan, floor-plan-mapper, floor-planning, floorplan, floorplan-construction, good-first-pr, good-first-project, help-wanted, javascript, mantine, mongodb, mongoose, nodejs, pixijs, react, reactjs, room-planner, zustand
• Language: TypeScript
• Homepage: https://arcada.nicoleta.cc
• Size: 6 MB
• Stars: 82
• Watchers: 4
• Forks: 23
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



## Introduction

Even had to redesign a room, a floor, or your entire house, and you spent hours drawing floor plans by hand, on graph paper, trying to make sure your sofa will fit next to the dresser? I certainly have, and it's a frustrating experience. I think we can do better than that.

As the vast majority of floor planner apps are available as part of a paid service, or too complicated to use for my needs, I decided to write my own. 

Enter Arcada, an open-source floor planner app.

![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB) 

![Pixi.JS](https://img.shields.io/badge/Pixi.JS-EF2D5E?style=for-the-badge)

![Express.js](https://img.shields.io/badge/express.js-%23404d59.svg?style=for-the-badge&logo=express&logoColor=%2361DAFB)

![MongoDB](https://img.shields.io/badge/MongoDB-%234ea94b.svg?style=for-the-badge&logo=mongodb&logoColor=white)

## Features

### 👷‍♀️ Add walls



  



### ⚒️ Edit walls



  



### 🛋️ Add/edit furniture



  



### 🚪 Add doors/windows



  



### 📏 Measure tool



  



#### 🌟 Accurate to scale

#### 🌟 Multiple floor support

#### 🌟 Print your designs

#### 🌟 Save/load support

#### 🌟 Component library with plenty of options

#### 🌟 Cross-platform

## Tech stack and docs

Client built using React, Pixi.js, Zustand, with Mantine as the component library for the UI. The floor plan engine is custom built. 

Server-side powered by Express.js, using MongoDB with Mongoose as ODM. 

[![server - source code](https://img.shields.io/badge/server-source_code-blue?style=for-the-badge)](https://github.com/mehanix/arcada-backend)

[![view - (New!) Documentation](https://img.shields.io/badge/view-Documentation-blue?style=for-the-badge)](https://github.com/mehanix/arcada/blob/4ab6e5d267bd901d2c8b962a782df3f422358d86/docs/Docs%20-%20Bachelor's%20thesis.pdf "Go to project documentation")

## Quick setup

Clone this repo and the `arcada-backend` repo. Run the following:

```

npm i 

npm run start

```

Launch the back-end using `node app.js`.

## Demo

If you want to run the app for yourself the easiest way to to is to use the following [docker-compose setup](https://github.com/perguth/arcada-setup). Have fun!

[![Demo - arcada.nicoleta.cc](https://img.shields.io/badge/Demo_available-arcada.nicoleta.cc-blue?style=for-the-badge)](https://arcada.nicoleta.cc)