85 lines
2.1 KiB
ReStructuredText
85 lines
2.1 KiB
ReStructuredText
Project smokeflow1771373753
|
|
===========================
|
|
|
|
About smokeflow1771373753
|
|
-------------------------
|
|
Ocyan project: smokeflow1771373753
|
|
|
|
Installation
|
|
------------
|
|
Create a virtualenv, you only need to do this once for each project::
|
|
|
|
mkvirtualenv smokeflow1771373753
|
|
|
|
Next build the project, by installing dependencies and creating the database::
|
|
|
|
make
|
|
|
|
Running
|
|
-------
|
|
Activate the virtualenv::
|
|
|
|
workon smokeflow1771373753
|
|
|
|
You can see which virtualenv is activated, because your
|
|
terminal will be prefixed with (smokeflow1771373753).
|
|
|
|
Next start the development server::
|
|
|
|
make run
|
|
|
|
Testing
|
|
-------
|
|
Testing is done with the default Django testing capabilities. Check the 'Testing in Django' chapter in Django documentation for details.
|
|
|
|
To run the tests, issue the following command::
|
|
|
|
make test
|
|
|
|
Linting
|
|
-------
|
|
Source code is formatted using the `black`[1] formatter in its default settings. Installing format-on-save support for your editor is highly recommended.
|
|
`Pylint`[2] is used for source code analysis.
|
|
All utilities are installed via the test extra. This extra is installed by default when using the Makefile.
|
|
|
|
The following command check style and syntax::
|
|
|
|
make lint
|
|
|
|
|
|
1. black: https://pypi.org/project/black/
|
|
2. pylint: https://pypi.org/project/pylint/
|
|
|
|
Edit template translation
|
|
-------------------------
|
|
The translation in templates
|
|
|
|
Activate the virtualenv::
|
|
|
|
workon smokeflow1771373753
|
|
|
|
Create the locale directory in the root of the project::
|
|
|
|
mkdir smokeflow1771373753/locale
|
|
|
|
Go in the project_name directory::
|
|
|
|
cd smokeflow1771373753/
|
|
|
|
Run this command to create a file with all translatable strings in the project (note: this is only for the dutch translations)::
|
|
|
|
manage.py makemessages -l nl
|
|
|
|
Go to your text editor and go in this file::
|
|
|
|
smokeflow1771373753/smokeflow1771373753/locale/nl/LC_MESSAGES/django.po
|
|
|
|
This file will have all of the translations some will be correct and dont need to be chanced
|
|
|
|
Edit all the translations u want to change
|
|
Delete all of the translation u dont want to chance
|
|
save file
|
|
|
|
Apply the translations::
|
|
|
|
manage.py compilemessages |