htmx_starter

faststart htmx + tailwindcss + django + postgres + docker template

see the readme in the dango project for more info

To set up:

• Check in the initial commit
• use pyenv to get python 3.11
• install requirements
• decide your project name & swap out the project name for your project name. we'll write it like this from here on

Rename project:

• rename the project & the project folder - do pycharm 'rename' on the project folder

• rename the htmx_starter django app

• do search and replace for 'htmx_starter' and replace with your project name

• create a database called using: `createdb

• create a .env file with (minimally) DATABASE_URL=postgres://127.0.0.1:5432/<project>

Other handy commands:

• manage.py migrate
• manage.py tailwind install
• tailwind start for monitor - use safari: less caching
• edit the run config to use the proper working directory
• set 'template language' to 'django' in the settings: langugaes and frameworks / template language -> django

Settings

Moved to settings.

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 a 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 <project>

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 pytest

$ pytest

Live reloading and Sass CSS compilation

Moved to Live reloading and SASS compilation.

Email Server

In development, it is often nice to be able to see emails that are being sent from your application. If you choose to use MailHog when generating the project a local SMTP server with a web interface will be available.

1. Download the latest MailHog release for your OS.

2. Rename the build to MailHog.

3. Copy the file to the project root.

4. Make it executable:

   $ chmod +x MailHog
   

5. Spin up another terminal window and start it there:

   ./MailHog
   

6. Check out http://127.0.0.1:8025/ to see how it goes.

Now you have your own mail server running locally, ready to receive whatever you send it.

Deployment

The following details how to deploy this application.

Heroku

See detailed cookiecutter-django Heroku documentation.