elpatron
e6fbe84d58
Document container startup and local port configuration in README, including a .env example for quick setup. Made-with: Cursor
57 lines
1.4 KiB
Markdown
57 lines
1.4 KiB
Markdown
# Elpatrons Date Calculator
|
|
|
|
A modern Python web application (Flask) that enables various date calculations through a clear, accessible web interface. Features include calculating days between dates, working days with state-specific holidays, calendar weeks, date arithmetic, and more. The application supports German and English languages, includes a REST API, and is designed with accessibility in mind.
|
|
|
|
## Documentation
|
|
|
|
- **[English Documentation](README_en.md)** - Complete documentation in English
|
|
- **[Deutsche Dokumentation](README_de.md)** - Vollständige Dokumentation auf Deutsch
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
pip install -r requirements.txt
|
|
python app.py
|
|
```
|
|
|
|
## Docker Compose
|
|
|
|
Run the app with Docker Compose and configure the local host port via `.env`.
|
|
|
|
1. Create a `.env` file in the project root (or copy `.env.example`):
|
|
|
|
```bash
|
|
# macOS / Linux
|
|
cp .env.example .env
|
|
|
|
# Windows (PowerShell)
|
|
Copy-Item .env.example .env
|
|
```
|
|
|
|
2. Set the local host port in `.env`:
|
|
|
|
```dotenv
|
|
LOCAL_PORT=5000
|
|
```
|
|
|
|
3. Build and start the container:
|
|
|
|
```bash
|
|
docker compose up --build -d
|
|
```
|
|
|
|
4. Open the app in your browser:
|
|
|
|
```text
|
|
http://localhost:<LOCAL_PORT>
|
|
```
|
|
|
|
Visit [https://date.elpatron.me](https://date.elpatron.me) for the live demo.
|
|
|
|
## License
|
|
|
|
This project is licensed under the [MIT License](LICENSE).
|
|
|
|
---
|
|
|
|
(c) 2025 [Markus Busche](https://digitalcourage.social/@elpatron) |