Skip to content

Commit 6eaed28

Browse files
committed
Update Readme
1 parent d96f1e7 commit 6eaed28

5 files changed

Lines changed: 16 additions & 4 deletions

File tree

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
A Django package for creating email-based learning platforms with IMAP integration and React frontend components.
88

99
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
10-
[![Python](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
10+
[![Python](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
1111
[![Django](https://img.shields.io/badge/django-5.0+-green.svg)](https://www.djangoproject.com/)
1212
![Tests](https://github.com/AvaCodeSolutions/django-email-learning/actions/workflows/pr-check.yml/badge.svg)
1313

@@ -50,9 +50,9 @@ A quick look at the platform interface:
5050

5151
| Course Dashboard | Public Organization Page |
5252
| --- | --- |
53-
| ![Course Dashboard](assets/screenshots/course.png) | ![Public Organization Page](assets/screenshots/public-org.png) |
53+
| ![Course Dashboard](assets/screenshots/course-dashboard.jpeg) | ![Public Organization Page](assets/screenshots/public-org.jpeg) |
5454
| Learner Progress | Certificate |
55-
| ![Learner Progress](assets/screenshots/learner-progress.png) | ![Certificate](assets/screenshots/certificate.png) |
55+
| ![Learner Progress](assets/screenshots/learner-progress.jpeg) | ![Certificate](assets/screenshots/certificate.jpeg) |
5656

5757

5858
## Documentation
@@ -91,10 +91,13 @@ Add the required configuration for the site base URL in your Django settings:
9191

9292
```python
9393
DJANGO_EMAIL_LEARNING = {
94-
"SITE_BASE_URL": "<YOUR_SITE_BASE_URL_STARTING_WITH_HTTP>"
94+
"SITE_BASE_URL": "<YOUR_SITE_BASE_URL_STARTING_WITH_HTTP>",
95+
"ENCRYPTION_SECRET_KEY": "<LONG_RANDOM_STRING>",
9596
}
9697
```
9798

99+
`ENCRYPTION_SECRET_KEY` should be a long random string used to protect sensitive values such as stored API Keys.
100+
98101
### 4. Configure Media Files
99102

100103
This app uses Django's MEDIA files to save organization logos. Ensure your media settings are configured correctly. See the [MEDIA_URL setting](https://docs.djangoproject.com/en/6.0/ref/settings/#media-url) for details.
@@ -138,6 +141,15 @@ Execute the content delivery job using:
138141
python manage.py deliver_contents
139142
```
140143

144+
You can also trigger this job via API, which is useful when running from an external scheduler (for example, cloud scheduler services):
145+
146+
```http
147+
GET /your_preferred_path/api/jobs/deliver_contents/
148+
Authorization: Bearer <API_KEY>
149+
```
150+
151+
This endpoint requires an API key. You can generate and manage API keys from Platform Settings > API Keys in the platform UI.
152+
141153
## Contributing
142154

143155
We welcome contributions! Please read our [Contributing Guide](https://github.com/AvaCodeSolutions/django-email-learning/blob/master/CONTRIBUTING.md) to learn about our development process, how to set up the development environment, and how to submit pull requests.
356 KB
Loading
476 KB
Loading
381 KB
Loading

assets/screenshots/public-org.jpeg

597 KB
Loading

0 commit comments

Comments
 (0)