summaryrefslogtreecommitdiff
path: root/README.md
blob: 9b544e3d8b8a60449181b91b37b4d33a6366f35e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58


# Web Template

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 checking for existing files. This means that existing files from other sources could be overwritten or deleted. Have a look at the ```Makefile``` and ```manage.py``` for details.


## Usage

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
sudo systemctl start <project_name>  # default <project_name> is webtemplate
curl http://localhost:<framework_port>/  # default <framework_port> is 28472
```

**Make sure to not edit settings.json until you uninstalled the project!**

You can remove it like this:

```
sudo systemctl stop <project_name>  # default <project_name> is webtemplate
make uninstall
make clean
```

You can also make your own project based on web-template:

```
git clone https://gitea.xengineering.eu/xengineering/web-template.git myproject
cd myproject
git remote rename origin template
```

You can then get updates from this template repository:

```
git fetch template
git merge template/master
```