diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 41 |
1 files changed, 34 insertions, 7 deletions
@@ -5,22 +5,49 @@ A template project for mixed static / dynamic web applications. +## Expected Environment + +- GNU/Linux +- systemd +- Git, make and python3 are installed + + +## Current State + +This project is in **early development** state. Please be very careful. The scripts behind the make targets will install and uninstall files on your system without any checks at the moment. Have a look at the ```Makefile``` and ```manage.py``` for details. + + ## Usage -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 +You can run this example or a web service based on this example like this: + +``` +git clone https://gitea.xengineering.eu/xengineering/web-template.git +cd web-template +nano settings.json # tweak to your needs +make all +make install +``` + +**Make sure to not edit settings.json until you uninstalled the project!** + +You can remove it like this: + +``` +make uninstall +make clean +``` + +You can also make your own project based on web-template: -### Use it for your Project ``` -# start 'myproject' (rename it if you want to) git clone https://gitea.xengineering.eu/xengineering/web-template.git myproject cd myproject git remote rename origin template ``` -### Get the latest Updates from this template Project +You can then get updates from this template repository: + ``` git fetch template git merge template/master |