Field Monitoring
1.0.0
1.0.0
  • Field Monitoring Module Documentation
  • INTRODUCTION
    • Glossary / Terminology
    • FAQ
    • Report an Issue / Contact us
  • PRODUCT / END-USER DOCUMENTATION
    • Overview
      • User roles and permissions (?)
    • Field Monitoring Module Navigation
    • Overall User Interface
    • Settings section
      • Adding and Editing Questions
      • Sites Management
    • Plan section
      • Building the Rationale For the Monitoring Activity
      • Logging Known Issues
      • Prestructuring Field Monitoring Activities
    • Collect section
      • Activities Overview
      • Drafting a Monitoring Activity
      • Checklist / Questionnaire Setup
      • Checklist Review
      • Assigning / Accepting / Rejecting a Visit
      • Data Collection
      • Report Finalization
      • Submission / Completing a Monitoring Activity
    • Analyze section
      • Monitoring Activity
      • Country Overview
    • FMM workflow (?)
  • TECHNICAL DOCUMENTATION
    • Architecture
    • Development Setup
    • Deployment / DevOps
    • Data Model
    • Fixtures and Management Commands
    • Integration with permissions framework
    • API Documentation
      • Error Handling
    • Frontend
      • Module Structure
      • Build Process
Powered by GitBook
On this page
  • Local Setup
  • Helpful Commands
  1. TECHNICAL DOCUMENTATION

Development Setup

PreviousArchitectureNextDeployment / DevOps

Last updated 5 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 check if the frontend / polymer is running. The Django app is running under ​

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

  6. To prepare data, load fixtures and run all required commands from the chapter .

  7. Go to login with your credentials

  8. Important! Users created with superuser command will not be associated with any country, which could lead to the frontend issues. You need to assign the country manually in the admin panel from the user edit page.

  9. Open ​ in your browser to see the frontend interface.

Helpful Commands

Here are some useful 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/
Fixtures and Management Commands
http://127.0.0.1:8082/api/admin/
http://127.0.0.1:8082/fm/