This repository contains the complete source code for Fast Investment Limited's Backoffice Software. The project is split into a Django-based backend API and a React/Vite-based frontend application.
backend/: Contains the Django & Django REST Framework application. Handles authentication, databases, business logic, endpoints, and caching (with Redis).frontend/: Contains the React + Vite application. Provides an interactive UI built with Tailwind CSS, shadcn/ui, and React Router.docker-compose.yaml: Root configuration file to spin up the entire software stack (backend, frontend, and a redis cache).
The easiest way to get the entire project up and running locally is to use Docker Compose. Ensure you have Docker desktop and Docker Compose installed.
From the root of the repository, execute:
docker-compose up --buildThis command will build the backend, the frontend, and start a Redis instance container automatically.
- Frontend App: Accessible at http://localhost:3000
- Backend API Server: Accessible at http://localhost:8000
Note for Windows users: if you have issues with paths in docker-compose, ensure your Docker Desktop is configured to use WSL2 and files are securely mounted.
If you prefer to run the components manually without Docker (or are developing specific modules), you can set them up individually.
You must ideally have a Redis server running locally on port 6379.
- Navigate to the
backend/directory:cd backend - Create and configure your
.envfile (see backend documentation). - Install Python dependencies:
pip install -r requirements.txt - Run migrations:
python manage.py migrate - Start backend server:
python manage.py runserver
For more details, please refer to the Backend README.
- Navigate to the
frontend/directory:cd frontend - Create and configure your
.envfile (e.g.VITE_API_BASE_URL=http://localhost:8000). - Install Node.js dependencies:
npm install - Start dev server:
npm run dev
For more details, please refer to the Frontend README.
- API Documentation: The backend auto-generates Swagger and ReDoc schemas. Once running, view it at http://localhost:8000.
- Frontend Details: Visit
frontend/README.md. - Backend Details: Visit
backend/README.md.