Skip to content

Commit f85b5c1

Browse files
committed
📝 Add Mailcatcher setup instructions for local email testing
1 parent a886384 commit f85b5c1

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
- 🔒 Secure password hashing by default.
2121
- 🔑 JWT (JSON Web Token) authentication.
2222
- 📫 Email based password recovery.
23+
- 📬 [Mailcatcher](https://mailcatcher.me) for local email testing during development.
2324
- ✅ Tests with [Pytest](https://pytest.org).
2425
- 📞 [Traefik](https://traefik.io) as a reverse proxy / load balancer.
2526
- 🚢 Deployment instructions using Docker Compose, including how to set up a frontend Traefik proxy to handle automatic HTTPS certificates.

development.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,18 @@ Adminer, database web administration: http://localhost:8080
2020

2121
Traefik UI, to see how the routes are being handled by the proxy: http://localhost:8090
2222

23+
## Mailcatcher
24+
25+
Mailcatcher is a simple SMTP server that catches all emails sent by the backend during local development. Instead of sending real emails, they are captured and displayed in a web interface.
26+
27+
This is useful for:
28+
29+
- Testing email functionality during development
30+
- Verifying email content and formatting
31+
- Debugging email-related functionality without sending real emails
32+
33+
The backend is automatically configured to use Mailcatcher when running with Docker Compose locally (SMTP on port 1025). All captured emails can be viewed at http://localhost:1080.
34+
2335
**Note**: The first time you start your stack, it might take a minute for it to be ready. While the backend waits for the database to be ready and configures everything. You can check the logs to monitor it.
2436

2537
To check the logs, run (in another terminal):

0 commit comments

Comments
 (0)