Financial Assurance Module
  • Financial Assurance Module Documentation
  • INTRODUCTION
    • Glossary / Terminology
    • FAQ
    • Releases / Changelog*
    • Report an Issue / Contact us
  • PRODUCT / END-USER DOCUMENTATION
    • Overview
      • User roles and permissions
    • Financial Assurance Module Navigation
    • Overall User Interface
    • Engagements section
      • Creation of Engagement
      • Reporting of Engagement
      • Submitting of Engagement
      • Finalize the Engagement
      • Export of Engagement
      • Cancellation of Engagement
    • Staff Spot Checks section
    • FAM workflow
  • TECHNICAL DOCUMENTATION
    • Architecture
    • Development Setup
    • Deployment / DevOps
    • Backend Module structure
    • Data Model
    • Fixtures & management commands
    • Integration with permissions framework
    • Interaction with VISION
    • API Documentation
      • Error Handling
    • Frontend
      • Module structure
      • Build process
      • Tests
Powered by GitBook
On this page
  • Local Setup
  • Helpful Commands
  1. TECHNICAL DOCUMENTATION

Development Setup

PreviousArchitectureNextDeployment / DevOps

Last updated 6 years ago

Local Setup

  1. Install for your OS. Also install Fabric via pip install fabric

  2. Create .env file with the reference of.env.exampleor receive .env file from your team member.

  3. Runfab up

  4. Go to to see the frontend / polymer running. The Django app is running under

    ​​

  5. Login to backend using fab ssh:backedand create admin with python manage.py createsuperuser

  6. Go to login with your credentials.

  7. Important! User created with superuser command will not be assosiated with any country, so frontend will fail. You need to assign the country manually in the admin panel from user edit page.

  8. And can now go to ​ to see the frontend interface.

Helpful Commands

Here are some docker tips:

display all containers:

$ docker ps

ssh into running django_api container

$ fab ssh:backend

stop all containers

$ fab stop_docker_containers

cleanup docker system: remove all inactive containers

$ docker system prune
Docker CE
http://127.0.0.1:8082/
http://127.0.0.1:8082/api/
http://127.0.0.1:8082/api/admin/
http://127.0.0.1:8082/ap/