Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
932 changes: 774 additions & 158 deletions DOCS.md

Large diffs are not rendered by default.

50 changes: 39 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,24 +51,48 @@ fpp --help
The setup wizard will guide you through the configuration step by step. 🎯
Once finished, your first app will be running – in less than the time it takes to make coffee. ☕🔥

Tip: In our [example folder](examples) we do also provide complete setup files for [Windows](examples/fpp_project/setup.bat) and [Linux](examples/fpp_project/setup.sh) servers.
If your want to use them, just download the file you need into your project folder and do:
**Tip:** We recommend installing Flask++ globally. If your OS does not support installing PyPI packages outside virtual environments,
you can create a workaround like this:

```bash
cd path/to/project
./setup.[sh|bat]
```
sudo su
cd /opt
mkdir flaskpp
cd flaskpp

python3 -m venv .venv
source .venv/bin/activate

pip install --upgrade pip
pip install flaskpp

In this case only on Windows systems you need to install Python before. On Linux systems just run the script as root to ensure python. ✨
cat > cli <<EOF
#!/usr/bin/env bash
exec /opt/flaskpp/.venv/bin/python -m flaskpp "$@"
EOF
chmod +x cli
ln -s /opt/flaskpp/cli /usr/local/bin/fpp

cd ..
groupadd shared
find /home -mindepth 1 -maxdepth 1 -type d -print0 |
while IFS= read -r -d '' dir; do
user=$(basename "$dir")
usermod -aG shared "$user"
done
chown -R root:shared flaskpp
chmod -R 2775 flaskpp
exit

newgrp shared
```

---

## 🧩 Modules

Inside the example folder you’ll also find an [example module](examples/example_module) to get you started.
Use it as an inspiration for your own modules or generate basic modules using the Flask++ CLI. 😉

`fpp modules create module_name`
To get started with modules, you can generate basic modules using the Flask++ CLI: `fpp modules create [module_name]`
Use as a starting point for your own modules. 😉

---

Expand Down Expand Up @@ -112,8 +136,12 @@ server {
---

## 📝 Documentation

For further information about this framework and how to use it, you may like to read our [documentation](DOCS.md). 🫶🏼

> ⚠️ Note: The documentation is intended as an architectural and reference guide, it does not provide a step-by-step tutorial.
> This is especially because Flask++ is a CLI first framework that provides a zero-code bootstrapping experience.

---

### 🌱 Let it grow
Expand All @@ -130,4 +158,4 @@ Do whatever you want with it – open-source, commercial, or both. Follow your h

---

**GrowVolution e.V. 2025 – Release the brakes! 🚀**
**&copy; GrowVolution e.V. 2025 – Release the brakes! 🚀**
9 changes: 0 additions & 9 deletions examples/example_module/__init__.py

This file was deleted.

12 changes: 0 additions & 12 deletions examples/example_module/data/__init__.py

This file was deleted.

20 changes: 0 additions & 20 deletions examples/example_module/data/your_dataset.py

This file was deleted.

12 changes: 0 additions & 12 deletions examples/example_module/forms.py

This file was deleted.

27 changes: 0 additions & 27 deletions examples/example_module/handling/your_endpoint.py

This file was deleted.

6 changes: 0 additions & 6 deletions examples/example_module/manifest.json

This file was deleted.

24 changes: 0 additions & 24 deletions examples/example_module/routes.py

This file was deleted.

Binary file removed examples/example_module/static/picture.jpg
Binary file not shown.
15 changes: 0 additions & 15 deletions examples/example_module/templates/index.html

This file was deleted.

6 changes: 0 additions & 6 deletions examples/example_module/templates/vite_index.html

This file was deleted.

52 changes: 0 additions & 52 deletions examples/example_module/templates/your_form.html

This file was deleted.

96 changes: 0 additions & 96 deletions examples/fpp_project/setup.bat

This file was deleted.

Loading