/urbanscript

urbanscript helps you attain urban-like interiors with minimal resource footprint

Primary LanguageJavaScriptOtherNOASSERTION

UrbanScript

Table of Contents

Overview

UrbanScript is an innovative web-based application designed to transform living spaces using AI-driven room arrangement suggestions. Whether you're moving into a new home, office, redecorating, or simply curious about maximizing your space, UrbanScript provides tailored, visually appealing layouts to make your room more functional and aesthetically pleasing.

Motivation

In today's fast-paced world, creating a comfortable and organized living environment can be challenging. Many people struggle with room arrangements, often finding it difficult to visualize how different layouts might improve their space. UrbanScript was born out of the need to simplify this process, leveraging cutting edge technology to offer instant, professional-quality suggestions that anyone can implement.

Mission

Our mission is to empower individuals with the tools and inspiration they need to optimize both their living and working spaces. We believe that a well-arranged room can enhance both mental clarity and overall well-being. By providing personalized, next generation room layouts, UrbanScript aims to make home transformation accessible to everyone, regardless of their design experience.

Features

  • AI-Driven Room Layout Suggestions: Upload an image of your room, and receive tailored layout suggestions in seconds.
  • Alternative Text Input: Describe your room's layout, and UrbanScript will generate suggestions based on your description.
  • User-Friendly Interface: Simple, intuitive design to make your experience as seamless as possible.
  • Responsive Design: Optimized for both desktop and mobile devices, ensuring a consistent experience across platforms.
  • Privacy Focused: Your data and privacy are our top priority, with clear policies and secure data handling practices.

Tech Stack

  • Frontend: ##
  • Backend: ##
  • Database: ##
  • Deployment: ##
  • Testing: ##

Getting Started

To get a local copy up and running, follow these simple steps:

Prerequisites

  • Python: v3.8 or higher
  • Docker: Latest version

Installation

  1. Clone the Repository:

    git clone https://github.com/Deo-Ekodi/urbanscript.git
cd urbanscript

  2. Set Up the Backend:

    cd backend

django-admin startproject urbanscript
cd urbanscript
python -m venv venv
source venv/bin/activate  # On Windows use `venv\Scripts\activate`
pip install -r requirements.txt

  3. Set Up the Frontend:

    frontend commands here

  4. Run the Backend:

    pip install django

  5. Run with next.js run and depploy with vercel

    vercel build && vercel deploy --prebuilt

    To deploy to development, use

    vercel --prod

Run with Docker

  1. Build and Start the Containers:

    docker-compose up --build

  2. Access the Application:

    localhost servers here

Directory Structure

[project structure]

Usage

Once the application is up and running:

  1. Navigate to the Home Page: Upload a photo of your room or use the description input feature to describe your room.
  2. Receive Layout Suggestions: View AI-generated room layout suggestions. You can scroll through multiple options and select the one you like best.
  3. Save and Implement: Download the suggested layout and implement it in your space.

Contribution Guidelines

We welcome contributions from the community! If you want to contribute:

  1. Fork the repository.
  2. Clone the repository (git clone https://github.com/Deo-Ekodi/urbanscript.git)
  3. Create a new branch (git checkout -b branch-name).
  4. Commit your changes (git commit -m 'commit message').
  5. Push to the branch (git push origin branch-name).
  6. Open a Pull Request.

Please ensure your code adheres to our coding standards and is thoroughly tested.

License

This project is licensed under a private License - see the LICENSE file for details.

Thank you for checking out UrbanScript! We’re excited to see how you transform your space with our tool. For any inquiries, feel free to contact us.