{"id":20313092,"url":"https://github.com/edoburu/django-project-template","last_synced_at":"2025-07-20T09:05:22.256Z","repository":{"id":5581612,"uuid":"6787676","full_name":"edoburu/django-project-template","owner":"edoburu","description":"Django project layout to quickly start build fantastic websites! (included npm, libsass, frontend setup and base Django apps)","archived":false,"fork":false,"pushed_at":"2022-12-08T03:12:29.000Z","size":640,"stargazers_count":127,"open_issues_count":4,"forks_count":50,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-12-08T23:30:18.460Z","etag":null,"topics":["django","django-project-template"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/edoburu.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-11-21T00:30:13.000Z","updated_at":"2024-10-22T15:35:49.000Z","dependencies_parsed_at":"2023-01-11T17:00:04.100Z","dependency_job_id":null,"html_url":"https://github.com/edoburu/django-project-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edoburu%2Fdjango-project-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edoburu%2Fdjango-project-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edoburu%2Fdjango-project-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edoburu%2Fdjango-project-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/edoburu","download_url":"https://codeload.github.com/edoburu/django-project-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230462906,"owners_count":18229864,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["django","django-project-template"],"created_at":"2024-11-14T18:09:15.246Z","updated_at":"2024-12-19T16:11:52.670Z","avatar_url":"https://github.com/edoburu.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":".. TODO: Complete the README descriptions and \"about\" section.{% if False %}{# Hiding GitHub README #}\n\n.. image:: https://img.shields.io/travis/edoburu/django-project-template/master.svg?branch=master\n    :target: http://travis-ci.org/edoburu/django-project-template\n.. image:: https://img.shields.io/codecov/c/github/edoburu/django-project-template/master.svg\n    :target: https://codecov.io/github/edoburu/django-project-template?branch=master\n\nDjango project template\n=======================\n\nThis project template creates a Django 1.11 / 2.0 project with a base set of applications\n\nFeatures\n---------\n\nInstalled apps:\n\n* Django 1.11+\n* MySQLdb or Psycopg2\n* py.test_ and coverage setup\n* Pillow_\n* SORL-Thumbnail_\n* IPython_ + ptpython_\n* Raven_\n* django-admin-tools_\n* django-analytical_\n* django-axes_\n* django-compressor_\n* django-crispy-forms_\n* django-debugtools_\n* django-environ_\n* django-filebrowser-no-grapelli_\n* django-fluent-dashboard_\n* django-healthchecks_\n* django-webmaster-verification_\n\nConfigured URLs:\n\n* ``/robots.txt``\n* ``/sitemap.xml``\n* ``/admin/``\n\nTemplates:\n\n* ``base.html``\n* ``403.html``\n* ``404.html``\n* ``500.html``\n\nFeatures:\n\n* 12factor app settings\n* WSGI deployment scripts\n* CSS and JavaScript paths configured\n* HTML5shiv + jQuery Installed\n* Bootstrap 3 based CSS reset\n* Dockerfile available\n* Gulpfile with SASS_, LiveReload_ and spritesmith_ setup (can be discarded)\n* Uptime monitoring URL (``/api/health/``)\n\nUsage\n-----\n\nCreate a Django project:\n\n.. code-block:: bash\n\n    mkdir my-website.com\n    cd my-website.com\n    django-admin.py startproject mywebsite . -e py,rst,example,gitignore,ini,min -n Dockerfile --template=https://github.com/edoburu/django-project-template/archive/master.zip\n\nThe layout uses an ``src`` folder.\nThis allows you to create folders like ``docs``, ``web``, ``logs``, ``etc`` at the toplevel.\nHowever, feel free to undo this change.\n\nThe remaining instructions - to start the development server - can be found in the generated ``README.rst`` file.\n\n\nDjango-fluent template\n----------------------\n\nIn a second branch, you'll find a project template for the django-fluent_ CMS:\n\n.. code-block:: bash\n\n    mkdir my-website.com\n    cd my-website.com\n    django-admin.py startproject mywebsite . -e py,rst,example,gitignore,ini,min -n Dockerfile --template=https://github.com/edoburu/django-project-template/archive/django-fluent.zip\n\n\nOptional features\n=================\n\nAs extra treat, the CSS files are easier to edit using SASS_.\nChanges are automatically visible in the browser using LiveReload_.\n\n.. note::\n\n    This feature is optional. If you don't like to use it, the project already has a ``screen.css`` file which can be used and edited.\n    Feel free to remove those files in your own projects or fork (``gulpfile.js``, ``package.json``, and ``frontend/sass``).\n    However, we highly recommended to take a look at it.\n\n\nLocal testing\n=============\n\nA quick script to allow local testing:\n\n.. code-block:: bash\n\n    sed -i -e 's/{{ project_name }}/project_name/g' Dockerfile src/project_name/settings/*.py src/*.py src/frontend/views.py src/tests/test_wsgi.py\n    sed -i -e 's/{{ secret_key|safe }}/c6!x_#)=rim8n1j90f#al%m9i)zb2zu@i)846ps_\u0026%-5@6o=q6/g' src/project_name/settings/defaults.py\n\n.. _bpython: http://bpython-interpreter.org/\n.. _django-analytical: https://github.com/jcassee/django-analytical\n.. _django-axes: https://github.com/django-security/django-axes\n.. _django-admin-tools: https://bitbucket.org/izi/django-admin-tools\n.. _django-compressor: https://django_compressor.readthedocs.io/\n.. _django-crispy-forms: https://django-crispy-forms.readthedocs.io/\n.. _django-debugtools: https://github.com/edoburu/django-debugtools\n.. _django-environ: https://github.com/joke2k/django-environ\n.. _django-filebrowser-no-grapelli: https://github.com/vdboor/django-filebrowser-no-grappelli-django14\n.. _django-fluent-dashboard: https://github.com/edoburu/django-fluent-dashboard\n.. _django-healthchecks: https://github.com/mvantellingen/django-healthchecks\n.. _django-webmaster-verification: https://github.com/nkuttler/django-webmaster-verification\n.. _LiveReload: http://livereload.com/\n.. _IPython: http://ipython.org/\n.. _Pillow: https://github.com/python-pillow/Pillow\n.. _ptpython: https://github.com/jonathanslenders/ptpython\n.. _py.test: http://docs.pytest.org/\n.. _Raven: https://github.com/getsentry/raven-python\n.. _SORL-Thumbnail: https://github.com/sorl/sorl-thumbnail\n.. _spritesmith: https://github.com/twolfson/gulp.spritesmith\n\n\n------------\n\n.. {% else %}\n\n{{ project_name|title }} Project\n========================================\n\nAbout\n-----\n\nDescribe your project here.\n\nPrerequisites\n-------------\n\n- Python \u003e= 2.7\n- pip\n- virtualenv (virtualenvwrapper is recommended)\n\nInstallation\n------------\n\nTo setup a local development environment::\n\n    virtualenv env --prompt=\"({{ project_name }})\"  # or mkvirtualenv {{ project_name }}\n    source env/bin/activate\n\n    cd src\n    make\n\n    cp {{ project_name }}/settings/local.py.example {{ project_name }}/settings/local.py  # To enable debugging\n    edit {{ project_name }}/settings/local.py    # Enter your DB credentials\n\n    sudo su - postgres\n    createuser {{ project_name }}  -P   # testtest is the default password\n    createdb --template=template0 --encoding='UTF-8' --lc-collate='en_US.UTF-8' --lc-ctype='en_US.UTF-8' --owner={{ project_name }} {{ project_name }}\n    exit\n\n    ./manage.py migrate\n    ./manage.py runserver\n\nCompiling SASS files\n~~~~~~~~~~~~~~~~~~~~\n\nSass files are compiled to CSS during the development.\nAt the server, there is no need for installing development tools.\n\nTo setup your development system, install NodeJS from https://nodejs.org/.\nOn Mac OSX, you can also use ``brew install libsass node``.\n\nRun the following command to compile SASS_ files::\n\n    make watch\n\nThis will compile the files, and watch for changes.\nIt also has LiveReload_ support.\nInstall a browser plugin from: http://livereload.com/extensions/\nand toggle the \"LiveReload\" button in the browser to see CSS changes instantly.\n\nLicense\n-------\n\nDescribe project license here.\n\n\n.. Add links here:{% endif %}\n\n.. _django-fluent: http://django-fluent.org/\n.. _LiveReload: http://livereload.com/\n.. _SASS: http://sass-lang.com/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedoburu%2Fdjango-project-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fedoburu%2Fdjango-project-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedoburu%2Fdjango-project-template/lists"}