new file: .gitignore
new file: Dockerfile new file: README.md new file: app.py new file: index.html new file: projekte des/PROJECT_DESCRIPTION.txt new file: projekte des/WEBSITE_DESCRIPTION.md new file: projekte des/website_project_description_en.txt new file: requirements.txt new file: script.js new file: static/css/styles.css new file: static/js/script.js new file: styles.css new file: templates/about.html new file: templates/base.html new file: templates/contact.html new file: templates/index.html new file: templates/minecraft.html new file: templates/project_detail.html new file: templates/projects.html
This commit is contained in:
77
README.md
Normal file
77
README.md
Normal file
@@ -0,0 +1,77 @@
|
||||
# Devanturas by SimolZimol
|
||||
|
||||
Professional Minecraft Plugin development and Discord bot programming, now powered by a Flask web app.
|
||||
|
||||
## Features
|
||||
- English website with sections: Home, Projects, Minecraft, About, Contact
|
||||
- Projects overview plus individual project pages (detail pages with feature lists, commands, install steps)
|
||||
- Dedicated Minecraft page with services and expertise
|
||||
- External links for each project (GitHub, Modrinth, SpigotMC, Wiki, Issues)
|
||||
- No links to private Gitea (as requested)
|
||||
|
||||
## Project Structure
|
||||
```
|
||||
website/
|
||||
├─ app.py # Flask app and routes
|
||||
├─ requirements.txt # Python dependencies
|
||||
├─ templates/ # Jinja2 templates
|
||||
│ ├─ base.html
|
||||
│ ├─ index.html
|
||||
│ ├─ projects.html
|
||||
│ ├─ project_detail.html
|
||||
│ ├─ minecraft.html
|
||||
│ ├─ about.html
|
||||
│ └─ contact.html
|
||||
└─ static/
|
||||
├─ css/
|
||||
│ └─ styles.css
|
||||
└─ js/
|
||||
└─ script.js
|
||||
```
|
||||
|
||||
## Quickstart (Windows PowerShell)
|
||||
|
||||
```pwsh
|
||||
# 1) Navigate to the project directory
|
||||
Set-Location -Path "c:\Users\Simon.Speedy\Documents\dev projekte\website"
|
||||
|
||||
# 2) Create and activate a virtual environment
|
||||
python -m venv .venv
|
||||
.\.venv\Scripts\Activate.ps1
|
||||
|
||||
# 3) Install dependencies
|
||||
pip install -r requirements.txt
|
||||
|
||||
# 4) Run the development server
|
||||
python app.py
|
||||
# The site will be available at http://127.0.0.1:5000
|
||||
```
|
||||
|
||||
If `python` isn’t found, try `py` instead of `python` in the above commands.
|
||||
|
||||
## Run with Docker (optional)
|
||||
|
||||
```pwsh
|
||||
# From project root
|
||||
docker build -t devanturas-site .
|
||||
docker run --rm -p 5000:5000 devanturas-site
|
||||
# Open http://localhost:5000
|
||||
```
|
||||
|
||||
## Customization
|
||||
- Add more projects by updating the data structures in `app.py` under `/projects` and the detail routes.
|
||||
- To add Wiki/Issues links per project, populate the `links` dict with `wiki` and `issues` keys. If a project should not expose these, simply omit the keys and the template won’t render them.
|
||||
- All styling lives in `static/css/styles.css`. JS behaviors live in `static/js/script.js`.
|
||||
|
||||
## Domain Notes
|
||||
Ready to deploy to any of your domains:
|
||||
- devanturas.de, devanturas.eu, devanturas.net
|
||||
- simolzimol.de, simolzimol.eu
|
||||
|
||||
You can serve this Flask app via any WSGI-capable host (e.g., Gunicorn + reverse proxy) or a PaaS of your choice.
|
||||
|
||||
## Privacy
|
||||
- No links to the private Gitea instance are included.
|
||||
|
||||
## License
|
||||
Choose a license and add it here if you plan to publish the source.
|
||||
Reference in New Issue
Block a user