summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorxengineering <mail2xengineering@protonmail.com>2020-12-22 16:01:53 +0100
committerxengineering <mail2xengineering@protonmail.com>2020-12-22 16:01:53 +0100
commit699bf610169daeb47bdcc894eb13fa1a706dc50b (patch)
tree66b3f619fece14608e83d98228ec9c200dcbc236 /README.md
parent7a89708c46b33d6d91164ff66d86d3c2471f531a (diff)
downloadweb-template-699bf610169daeb47bdcc894eb13fa1a706dc50b.tar
web-template-699bf610169daeb47bdcc894eb13fa1a706dc50b.tar.zst
web-template-699bf610169daeb47bdcc894eb13fa1a706dc50b.zip
Switch to static Web App
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 5 insertions, 23 deletions
diff --git a/README.md b/README.md
index 34376ff..a9f6052 100644
--- a/README.md
+++ b/README.md
@@ -2,26 +2,15 @@
# Web Template
-A template project for dynamic web applications.
+A template project for mixed static / dynamic web applications.
## Usage
-### Just try it
-```
-# Install Flask and waitress with your linux package manager.
-# Otherwise you could use pip:
-pip3 install --user Flask waitress
-
-git clone https://github.com/xengineering/web-template.git
-cd web-template
-python3 main.py
-
-# switch to another terminal
-
-curl http://localhost:8080 # test with curl
-firefox http://localhost:8080 # test with firefox
-```
+Just follow these steps:
+1. Edit config.json
+2. Edit the files in the webroot folder
+3. Upload the webroot to your target server with ```python3 manage.py deploy``` via SSH / rsync
### Use it for your Project
```
@@ -37,10 +26,3 @@ git fetch template
git merge template/master
```
-
-## Used Technologies
-
-- [Python 3](https://www.python.org/)
-- [Python Flask](https://palletsprojects.com/p/flask/)
-- [Waitress WSGI Server](https://github.com/Pylons/waitress)
-- Pure HTML, CSS and JavaScript