Files
Refactored-App/README.md
2026-04-01 03:57:04 +02:00

2.3 KiB

Django Port Workspace

This folder contains the rewrite target for the current FastAPI + React application. It is intended to be self-contained.

What is here

  • backend: Django project and domain apps
  • frontend: SvelteKit frontend with a local manual shadcn-style component layer
  • data/legacy: bundled legacy SQLite sources used by import_legacy_data
  • docs/port-plan.md: migration strategy and scope

Self-contained data

The folder already contains:

That means django-port no longer depends on the repo-root legacy databases for normal use or for re-running the importer.

Fresh Machine Setup

django-port is now structured so it can be pushed as its own repository and used without the rest of the original workspace.

Backend setup:

cd backend
python3 -m venv .venv
source .venv/bin/activate
pip install -e .
cp .env.example .env
python manage.py migrate
python manage.py runserver

Frontend setup:

cd frontend
npm install
cp .env.example .env
npm run dev

Default local URLs:

  • frontend: http://localhost:5173
  • backend API: http://localhost:8000/api

Pushing As Its Own Repo

If this folder is moved into a new repository, include at minimum:

  • backend/
  • frontend/
  • data/legacy/
  • docs/
  • .gitignore
  • README.md

If you want the seeded app data on the destination machine, commit and push:

The repo does not need to include:

  • any files outside django-port
  • a local virtualenv
  • frontend/node_modules
  • frontend/.svelte-kit

Environment Files

Example env files are included at:

What is intentionally not done

  • No package installation
  • No Svelte or Django bootstrapping commands
  • No heavy build, dev-server, or migration runs

Everything needed for the port itself now lives under this folder.