See #50.

mix command will be a command to compile mix assets.

• Automatically collects apps with Laravel Mix supports.
• --watch flag to keep watching asset changes.
• APPNAME option to especially build a specific app's assets. If not provided, all will be build.
• --list flag to only list apps with Laravel Mix support.

This issue, if closed, closes #7.

Laravel Mix is a great solution that solves %80 of the use case.

SPA is not needed for many projects. VueJS is a good solution for integrating AJAX to some parts of web page, e.g. a search bar or a list with pagination.

To Do

• [ ] createapp command to start an app with Laravel Mix with its gitignore
• [ ] mix command for compiling mix assets
• [ ] serve command to watch mix assets and run Django server in parallel

Some distributions may distribute older versions of specific packages for the sake of consistency but you might need that package's official LTS for your development workflow. I've come across a situation that Ubuntu 20.04 distributing Node 10 while Node's official LTS is 14. It caused VueJS to not compile since it requires at least 12.

That's why <SYSTEMNAME>.requirements.txt is not a good idea. Instead, we can provide a shell script, automagically installing the dependencies from dedicated sources.

Black fails, see the output:

[WARNING] Unstaged files detected.
[INFO] Stashing unstaged files to /home/erayerdin/.cache/pre-commit/patch1563987583.
Trim Trailing Whitespace.................................................Failed
hookid: trailing-whitespace

Files were modified by this hook. Additional output:

Fixing LICENSE.txt

Fix End of Files.........................................................Failed
hookid: end-of-file-fixer

Files were modified by this hook. Additional output:

Fixing requirements.txt
Fixing LICENSE.txt
Fixing sozluk/architecture.drawio

Check Yaml...............................................................Passed
Check for added large files..............................................Passed
black....................................................................Failed
hookid: black

Files were modified by this hook. Additional output:

reformatted /foo/apps.py
All done! ✨ 🍰 ✨
1 file reformatted, 18 files left unchanged.

seed isort known_third_party.............................................Passed
isort....................................................................Passed
[WARNING] Stashed changes conflicted with hook auto-fixes... Rolling back fixes...
[INFO] Restored changes from /home/erayerdin/.cache/pre-commit/patch1563987583.

Added

• pytest-factoryboy dev dep (closes #47)
• core_user and core_user_factory fixtures
• pytest-cov dev dep
• DJANGO_STATIC_URL and DJANGO_STATIC_ROOT env vars (closes #54)

Changed

• Fixed DJANGO_USE_L10N variable (closes #55)
• ubuntu.requirements.txt is now a bash script named ubuntu20.requirements.bash (closes #49)
• Migrated isort and pytest to pyproject.toml (closes #48)

https://github.com/erayerdin/sos-django-template/blob/943749530a4db6f4da258eec823ebdeb01000c81/project/settings/defaults.py#L112

This line should be USE_L10N.

A couple of environment variables to set settings related to static files.

• DJANGO_STATIC_URL to set STATIC_URL environment variable, defaults to /static/.
• DJANGO_STATIC_ROOT to set STATIC_ROOT environment variable. Default is computational and will result it django subdirectory of system's temp directory.

pyproject.toml is the new standard to define building process.

List of Things to Migrate

• [x] pytest
• [x] isort
• [ ] flake8, but 3rd party solution is not preferred

Added

• Poetry Support (closes #40)
• Core App (closes #34)
• Timestamp models (closes #44)
• CoreUser model (closes #35)
• VSCode ignores
• Not Implemented View (closes #37)
• Django Extensions (closes #17)

Removed

• Travis

Setting up the project could be much more easier. We need a setup cli. Let sos be cli util, then:

sos new NAME
sos new NAME --lib

It could also provide interactive setup.

See #50.

serve command will be an alternative to runserver command. It will watch Laravel Mix and run Django server in parallel and collectstatic before running Django server.

• Runs mix watch and runserver in parallel.
• Cleans collected static files on kill.
• --no-watch to not watch mix assets.
• --no-collect to not collect static files.
• --no-clean to not clean static files on kill.

See #50.

The provided modules are sometimes needed and sometimes not.

• Sometimes, apps are created for SRP, which means they are created to isolate a functionality in an app. For instance, a project might have an ajax app for providing JSON endpoints to bring dynamism to a web page or a rest app to isolate REST endpoints.
• Sometimes, apps are created as an extension. For instance, if a project has a different text formatting specification (like BBCode), it is better to isolate it into an app.
• Sometimes, apps are created to isolate a part of whole project. Let's say we have a web app with a homepage, a forum, a QA platform and a messaging platform. We would create separate apps for each.

So, adding models, views, tests and not including urls module is not always desirable. We can, however, provide a command that can create an app interactively, asking what part exactly a developer needs.

createapp will be a command in core app. It is an alternative to startapp command but different in behavior.

Interactivity

Upon python3 manage.py createapp, an interactive session will start. It is represented in order in the table below.

Note

In the table below, a module is a single py file while package is a directory with __init__.py in it.

| Condition | Order | Question | Answer Type | Default Answer | Description | |-|-|-|-|-|-| | - | 1 | Would you like to have models in your app? | y/n/Y/N | y | 1. Creates models module.
2. Adds # noqa comment at the end of models import.
3. Adds a # TODO remove noqa comment above import.
4. Adds explanation as to factories and drawio files. | | If y to 1 | 2 | Would you like to have factories in your app? | y/n/Y/N | y | 1. Creates factories module.
2. Adds appname.factories to conftest.py at root.
3. Adds explanation as to how to write factories. | | If y to 1 | 3 | Would you like to create arch.drawio file? | y/n/Y/N | n | Creates arch.drawio file. | | - | 4 | Would you like to have views in your app? | y/n/Y/N | y | Creates views package. | | If y to 4 | 5 | Would you like to have urls in your app? | y/n/Y/N | y | 1. Creates urls module.\n
2. Adds app_name variable to urls module so we can have namepsaces on urls.
3. Adds urlpatterns list.
4. Imports path and adds # noqa comment at the end.
5. Adds appname.urls to projects.url module. | | If y to 5 | 6 | What should be the root URL for your app? | text | empty | If left empty, attaches url to the root url. | | - | 7 | Would you like admin integration for your app? | y/n/Y/N | n | 1. Creates admin module.
2. Imports admin and adds # noqa to the end. | | If y to 4 | 8 | Would you like Laravel Mix support? | y/n/Y/N | n | Sets up Laravel Mix for the app. |

Gitignore

A .gitignore should be present at the root of each app so that it won't include unwanted files on commit.

I don't really know it is really necessary to ignore migration files from Black. I will add some thesis and antithesis below, which I will add to in time.

Leaving migrations as is, to me, sounds better. That's mainly because migrations are generated by computer. On the other hand, developers might edit migrations by hand and they might desire formatting functionality then.