j3d1
/
schickmacher
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
36 Commits 1 Branch 0 Tags 1.9 MiB
Python 59.2%
HTML 23.1%
Shell 5.9%
CSS 4.9%
SCSS 3.9%
Other 2.9%
Go to file
j3d1 9aa9c342bb wip 2019-11-25 13:41:24 +01:00
.envs Run django-compress in offline mode 2019-09-12 21:33:13 +02:00
.idea init commit 2019-09-05 10:37:43 +02:00
compose compress after collecting static files 2019-10-22 14:16:24 +02:00
config compress after collecting static files 2019-10-22 14:16:24 +02:00
docs init commit 2019-09-05 10:37:43 +02:00
locale Add basic form 2019-09-05 12:20:45 +02:00
requirements Update WeasyPrint and fix test.md 2019-09-24 11:39:49 +02:00
schickmacher wip 2019-11-25 13:41:24 +01:00
.coveragerc init commit 2019-09-05 10:37:43 +02:00
.dockerignore init commit 2019-09-05 10:37:43 +02:00
.editorconfig init commit 2019-09-05 10:37:43 +02:00
.gitattributes init commit 2019-09-05 10:37:43 +02:00
.gitignore wip 2019-09-25 14:43:24 +02:00
.pylintrc init commit 2019-09-05 10:37:43 +02:00
README.rst init commit 2019-09-05 10:37:43 +02:00
actual_production.yml add image path for push 2019-09-13 11:03:54 +02:00
local.yml init commit 2019-09-05 10:37:43 +02:00
manage.py init commit 2019-09-05 10:37:43 +02:00
merge_production_dotenvs_in_dotenv.py init commit 2019-09-05 10:37:43 +02:00
production.yml Use whitenoise to serve statices and use port 5000 2019-09-12 13:28:52 +02:00
pytest.ini init commit 2019-09-05 10:37:43 +02:00
setup.cfg init commit 2019-09-05 10:37:43 +02:00
test.md wip 2019-11-25 13:41:24 +01:00

README.rst 

Schickmacher
============

Apply templates and styles to markdown snippets to make them schick.

.. image:: https://img.shields.io/badge/built%20with-Cookiecutter%20Django-ff69b4.svg
     :target: https://github.com/pydanny/cookiecutter-django/
     :alt: Built with Cookiecutter Django
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
     :target: https://github.com/ambv/black
     :alt: Black code style


Settings
--------

Moved to settings_.

.. _settings: http://cookiecutter-django.readthedocs.io/en/latest/settings.html

Basic Commands
--------------

Setting Up Your Users
^^^^^^^^^^^^^^^^^^^^^

* To create a **normal user account**, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.

* To create an **superuser account**, use this command::

    $ python manage.py createsuperuser

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

Type checks
^^^^^^^^^^^

Running type checks with mypy:

::

  $ mypy schickmacher

Test coverage
^^^^^^^^^^^^^

To run the tests, check your test coverage, and generate an HTML coverage report::

    $ coverage run -m pytest
    $ coverage html
    $ open htmlcov/index.html

Running tests with py.test
~~~~~~~~~~~~~~~~~~~~~~~~~~

::

  $ pytest

Live reloading and Sass CSS compilation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Moved to `Live reloading and SASS compilation`_.

.. _`Live reloading and SASS compilation`: http://cookiecutter-django.readthedocs.io/en/latest/live-reloading-and-sass-compilation.html





Deployment
----------

The following details how to deploy this application.



Docker
^^^^^^

See detailed `cookiecutter-django Docker documentation`_.

.. _`cookiecutter-django Docker documentation`: http://cookiecutter-django.readthedocs.io/en/latest/deployment-with-docker.html