{"id":45782474,"url":"https://github.com/kartoza/django-bims","last_synced_at":"2026-04-21T16:01:04.113Z","repository":{"id":37376040,"uuid":"129988923","full_name":"kartoza/django-bims","owner":"kartoza","description":null,"archived":false,"fork":false,"pushed_at":"2026-02-23T16:36:56.000Z","size":74613,"stargazers_count":17,"open_issues_count":93,"forks_count":21,"subscribers_count":9,"default_branch":"main","last_synced_at":"2026-02-23T21:36:47.755Z","etag":null,"topics":["backbonejs","django","python"],"latest_commit_sha":null,"homepage":"https://fbis.sta.kartoza.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kartoza.png","metadata":{"files":{"readme":"README-dev.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":["kartoza"]}},"created_at":"2018-04-18T02:00:24.000Z","updated_at":"2026-02-23T16:27:36.000Z","dependencies_parsed_at":"2023-10-04T10:40:29.188Z","dependency_job_id":"f100c7dc-ed09-4964-b09e-83f4df314d5a","html_url":"https://github.com/kartoza/django-bims","commit_stats":null,"previous_names":[],"tags_count":79,"template":false,"template_full_name":null,"purl":"pkg:github/kartoza/django-bims","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kartoza%2Fdjango-bims","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kartoza%2Fdjango-bims/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kartoza%2Fdjango-bims/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kartoza%2Fdjango-bims/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kartoza","download_url":"https://codeload.github.com/kartoza/django-bims/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kartoza%2Fdjango-bims/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29856919,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-26T08:51:08.701Z","status":"ssl_error","status_checked_at":"2026-02-26T08:50:19.607Z","response_time":89,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backbonejs","django","python"],"created_at":"2026-02-26T11:12:46.627Z","updated_at":"2026-04-21T16:01:04.108Z","avatar_url":"https://github.com/kartoza.png","language":"JavaScript","funding_links":["https://github.com/sponsors/kartoza"],"categories":[],"sub_categories":[],"readme":"# Developer Documentation\n\n**Note:** This documentation is intentionally generic so that it can\nbe copy-pasted between projects - do not put project specific details here.\n\n## Application architecture under docker\n\nThe following diagram provides and overview of the core architecture\ncomponents (Database, uwsgi server, web server):\n\n![dockerdjangoarchitecture - new page 1](https://cloud.githubusercontent.com/assets/178003/5024388/750b85c8-6b12-11e4-97b0-c73b2d07e539.png)\n\n\nThe blue box is there to provide a means to develop on the same environment\nas you deploy and would not be relevant for server side deployments.\nEverything is managed using docker containers, with pycharm\nmaking ssh connections into the developer container and using the\npython interpreter found therein. Newer versions of PyCharm have 'native' docker support\nbut after testing we opted to continue to use the ssh method described here. You may want to\ntest when new versions of PyCharm come out in case they have improved the direct docker support.\n\n**Note:** You don't need to use this architecture, you can deploy as a standard\ndjango app using virtualenv and locally installed postgis, nginx etc.\n\n## Setup pycharm to work with a remove docker development environment\n\n### Build and run your dev docker image\n\nThis image extends the production one, adding ssh to it. You must\nhave built the production one first by following the \"Quick Installation Guide\"!\nWhen it's done, you can continue with this command:\n\nLinux and MacOS:\n\n```\nmake build-devweb\nmake devweb\n```\n\nWindows:\n\n```\nmake-devbuild.bat\nmake-devweb.bat\n```\n\n### Create a remote interpreter in pycharm\n\nOpen the project in pycharm then do:\n\n* File -\u003e Settings\n* Project Interpreter\n* Click on the gear icon next to project interpreter\n* Add remote...\n\nNow use these credentials:\n\n* SSH Credentials (tick)\n* Host: localhost\n* Port: (use the ssh port specified in the docker-compose.yml file)\n* User name: root\n* Auth type: password (and tick 'save password')\n* Password: docker\n* Python interpreter path: ``/usr/local/bin/python``\n\nWhen prompted about host authenticity, click Yes.\nAfter the python interpreter is set, set its path mapping:\n\n  * **Local path:** `\u003cpath to your git repo\u003e` (where your django project \n  located)\n  * **Remote path:** `/home/web/django_project`\n\nAfter that you should see something like this:\n   `\u003cProject root\u003e/django_project→/home/web/django_project`\n\nIn settings, django support:\n\n* tick to enable django support.\n* Set django project root to the path on your host that holds django code e.g.\n  ``\u003cpath to code base\u003e`` (where your django project located)\n* Set the settings option to your setting profile e.g.\n  ``core/settings/dev_docker.py``. If you need to use custom settings, copy\n  this file e.g. ``dev_docker_tim.py`` and place your modifications in your\n  personalised copy. The first import of your custom file should import from\n  dev_docker.\n\n* manage script (leave default)\n\n\n### Create the django run configuration\n\n* Run -\u003e Edit configurations\n* Click the `+` icon in the top left corner\n* Choose ``Django server`` from the popup list\n\nNow set these options:\n\n* **Name:** Django Server\n* **Host:** 0.0.0.0\n* **Port:** (use the http port specified in the docker-compose.yml file, e.g. 8080)`*` \n* **Run browser** If checked, it will open the url after you click run. You \nshould be able to access the running projecta on 0.0.0.0:63302 (the port that \nmapped to 8080)\n* **Additional options:** ``--settings=core.settings.dev_docker``\n* **Run browser:** Optionally set this to your IP address (MacOS/Linux) or your specific IP address (Windows) followed by the port forward address for port 8080 specified in your ``docker-compose.yml`` file. For example: ``http://0.0.0.0:63302``.\n* **Environment vars:** Leave as default unless you need to add something to the env\n* **Python interpreter:** Ensure it is set you your remote interpreter (should be\n  set to that by default)\n* **Interpreter options:** Leave blank\n* **Path mappings:** Here you need to indicate path equivalency between your host\n  filesystem and the filesystem in the remote (docker) host. Click the ellipsis\n  and add a run that points to your git checkout on your local host and the\n  /home/web directory in the docker host. e.g.\n  * **Local path:** \u003cpath to your git repo\u003e/django_project\n  * **Remote path:** /home/web/django_project\n* click OK to save your run configuration\n\nNow you can run the server using the green triangle next to the Django server\nlabel in the run configurations pull down. Debug will also work and you will be\nable to step through views etc as you work.\n\nI made a general overview screencast describing this process here:\n\n[![YouTube Screencast](http://img.youtube.com/vi/n-wwp17MqhU/0.jpg)](https://www.youtube.com/watch?v=n-wwp17MqhU \"YouTube Screencast\")\n\n\n## Running Tests\n\nTim write stuff here....\n\n\n## Developer FAQ\n\n**Q**: I get ``ImportError: Could not import settings core.settings.dev_docker``\nwhen starting the server.\n\n**A:** ``django_project/core/settings/secret.py is either corrupt or you don't\nhave permissions to read it as the user you are running ``runserver`` as. A\ncommon cause of this is if you are running the server in both production\nmode and developer mode on the same host. Simply remove the file or change\nownership permissions so that you can read/write it.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkartoza%2Fdjango-bims","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkartoza%2Fdjango-bims","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkartoza%2Fdjango-bims/lists"}