{"id":24989138,"url":"https://github.com/engineervix/blog-post--django-markdown-powered-emails","last_synced_at":"2025-03-29T11:40:42.576Z","repository":{"id":229297736,"uuid":"776328137","full_name":"engineervix/blog-post--django-markdown-powered-emails","owner":"engineervix","description":"This is a contrived Django project created as part of a blog post ","archived":false,"fork":false,"pushed_at":"2024-12-03T22:35:33.000Z","size":200,"stargazers_count":0,"open_issues_count":7,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-06T20:57:03.501Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://blog.victor.co.zm/markdown-powered-emails-in-django","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/engineervix.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-23T07:42:03.000Z","updated_at":"2024-11-23T03:37:21.000Z","dependencies_parsed_at":"2024-06-01T03:28:20.428Z","dependency_job_id":"0c119412-b149-4cb3-b4b2-6415b1e635a8","html_url":"https://github.com/engineervix/blog-post--django-markdown-powered-emails","commit_stats":null,"previous_names":["engineervix/blog-post--django-markdown-powered-emails"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineervix%2Fblog-post--django-markdown-powered-emails","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineervix%2Fblog-post--django-markdown-powered-emails/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineervix%2Fblog-post--django-markdown-powered-emails/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineervix%2Fblog-post--django-markdown-powered-emails/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/engineervix","download_url":"https://codeload.github.com/engineervix/blog-post--django-markdown-powered-emails/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246180898,"owners_count":20736459,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-04T12:19:39.044Z","updated_at":"2025-03-29T11:40:42.293Z","avatar_url":"https://github.com/engineervix.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Markdown-powered emails in Django\n\n\u003e An example Django application to illustrate the concept. See blog post [here](https://blog.victor.co.zm/markdown-powered-emails-in-django)\n\n[![CI/CD](https://github.com/engineervix/blog-post--django-markdown-powered-emails/actions/workflows/main.yml/badge.svg)](https://github.com/engineervix/blog-post--django-markdown-powered-emails/actions/workflows/main.yml)\n\n[![Python312](https://img.shields.io/badge/python-3.12-brightgreen.svg)](https://www.python.org/downloads/release/python-3120/)\n[![Node20](https://img.shields.io/badge/Node-v20-teal.svg)](https://nodejs.org/en/blog/release/v20.0.0)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)\n\n## First things first\n\nI recommend you test this with **Python 3.12**, because that's what I used for this particular project. However, it _should_ hopefully work with lower Python versions such us 3.10 and 3.11. You can use [pyenv](https://github.com/pyenv/pyenv) to install multiple python versions on your machine.\n\nYou'll also need **Node.js 20** on your machine. You can use tools such as [nvm](https://github.com/nvm-sh/nvm), [volta](https://volta.sh/), etc. to simplify managing Node.js versions on your machine.\n\n1. In your [**virtual environment**](https://realpython.com/python-virtual-environments-a-primer/), install Python dependencies\n\n   ```bash\n   pip install -r requirements.txt\n   ```\n\n2. Install Node.js dependencies\n\n   ```bash\n   npm install\n   ```\n\n## Getting Started\n\n- Apply database migrations\n\n  ```bash\n  ./manage.py migrate\n  ```\n\n- Create a `superuser`\n\n  ```bash\n  ./manage.py createsuperuser\n  ```\n\n- Create some test events\n\n  ```bash\n  ./manage.py create_events\n  ```\n\n- Simultaneously run the Django development server and the [MailDev](https://github.com/maildev/maildev) SMTP Server\n\n  ```bash\n  honcho start\n  ```\n\nYou can access the dev server at \u003chttp://127.0.0.1:8000\u003e. As indicated above, this project uses [MailDev](https://github.com/maildev/maildev) for viewing and testing emails generated during development. The MailDev server is accessible at \u003chttp://127.0.0.1:1080\u003e.\n\nWhen you register for an event, you should receive an email.\n\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fengineervix%2Fblog-post--django-markdown-powered-emails","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fengineervix%2Fblog-post--django-markdown-powered-emails","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fengineervix%2Fblog-post--django-markdown-powered-emails/lists"}