Skip to main content

Furniture Store Backend API

A comprehensive Flask-based backend system for managing furniture manufacturing operations, from raw materials to finished products.

Get StartedExplore API
📦
Inventory Management
Track materials and products
🏭
Production Control
Monitor manufacturing processes
📊
Catalog System
Manage wood types, colors, and furniture

Quick Start

Get your furniture store backend up and running in minutes

1

Clone the repository

Clone the project and navigate to the directory:
git clone https://github.com/furniture-store-utl/backend-furniture-store.git
cd backend-furniture-store
2

Set up virtual environment

Create and activate a Python virtual environment:
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
3

Install dependencies

Install all required Python packages:
pip install -r requirements.txt
4

Configure environment

Create a .env file based on the template:
cp .env-template .env
Edit .env with your database credentials:
DB_USER=your_user
DB_PASSWORD=your_password
DB_HOST=localhost
DB_PORT=3306
DB_NAME=furniture_store_db
5

Run the application

Start the Flask development server:
python run.py
The server will start at http://127.0.0.1:5000

Key Features

Everything you need to manage a furniture manufacturing operation

Catalog Management

Manage colors, wood types, furniture types, units of measure, and user roles with full CRUD operations

RESTful Architecture

Clean MVC pattern with Flask blueprints, service layer, and SQLAlchemy ORM

Database Management

MySQL backend with Alembic migrations, soft deletes, and comprehensive audit trails

Security Built-in

CSRF protection with Flask-WTF, secure environment configuration, and validation

Explore by Topic

Find what you need to build with the Furniture Store Backend

Architecture Overview

Learn about the layered MVC architecture and how the components work together

Read more

Catalog Endpoints

Complete API reference for managing colors, wood types, furniture types, and more

Explore API

Database Models

Understand the database schema and SQLAlchemy model definitions

View models

Project Structure

Navigate the codebase organization and understand where everything lives

Learn structure

Ready to get started?

Follow our quickstart guide to set up the Furniture Store Backend and start managing your manufacturing operations.

View Quickstart Guide

Build docs developers (and LLMs) love

Get started for freeTalk to us