Skip to content

Commit

Permalink
Merge pull request #59 from stuartmaxwell/dev
Browse files Browse the repository at this point in the history
  • Loading branch information
stuartmaxwell authored May 28, 2024
2 parents 4a8cf24 + dd78928 commit 8afddd2
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 91 deletions.
1 change: 1 addition & 0 deletions .github/workflows/docker-image.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ name: Build and Deploy Docker Image
on:
push:
branches: [main]
workflow_dispatch:

env:
REGISTRY: ghcr.io
Expand Down
39 changes: 0 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,3 @@
# stuartm.nz

The code for my stuartm.nz website.

## Requirements

- Django
- Postgres
- Whitenoise
- Gunicorn

## Installation

1. t.b.d.

## Usage

- Standard Django app

## Configuration

Rename `env.template` to `.env` and configure the following settings:

| Env Name | Env Value |
| ------------------- | -------------------------------------------------------------------------------------------------- |
| SECRET_KEY | The Django secret key to add to the `settings.py` file. |
| DEBUG | Ensure this is set to `False` in production. |
| ALLOWED_HOSTS | List of allowed hosts, e.g. `example.com,www.example.com`. |
| EMAIL_HOST | Name or IP address of the SMTP server. |
| EMAIL_PORT | The port of the SMTP server. |
| EMAIL_HOST_USER | The username to authenticate with the SMTP server. |
| EMAIL_HOST_PASSWORD | The password for the SMTP server username. |
| EMAIL_USE_TLS | Either `True` or `False` to use TLS. |
| DEFAULT_FROM_EMAIL | The email address to send emails from . |
| DB_ENGINE | The database engine to use. |
| DB_NAME | The database name to connect to. If using SQLite, this will be the filename without the extension. |
| DB_HOST | Name or IP address of the database server. |
| DB_PORT | The port of the database server. |
| DB_USER | The username to authenticate with the database server. |
| DB_PASSWORD | The password for the database server username. |
| WHITENOISE_STATIC | Boolean value that turns on Whitenoise for serving static content. |
| ADMIN_URL | The path to the Admin site so it can be hidden from easily being guessed. |
49 changes: 0 additions & 49 deletions docs/index.md

This file was deleted.

4 changes: 4 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,7 @@ target-version = "py312"

[tool.ruff.lint.pydocstyle]
convention = "google" # Accepts: "google", "numpy", or "pep257".

[tool.pytest.ini_options]
DJANGO_SETTINGS_MODULE = "config.settings_testing"
python_files = "tests.py test_*.py *_tests.py"
3 changes: 0 additions & 3 deletions pytest.ini

This file was deleted.

0 comments on commit 8afddd2

Please sign in to comment.