summaryrefslogtreecommitdiff
path: root/README.md
blob: fdd3386044e5f3b23fc08c5c7a0e453bf22def97 (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
59
60
61
# TUWF - The Ultimate Website Framework

This package provides the following set of modules:

- [TUWF](https://dev.yorhel.nl/tuwf/man)
- [TUWF::DB](https://dev.yorhel.nl/tuwf/man/db)
- [TUWF::Misc](https://dev.yorhel.nl/tuwf/man/misc)
- [TUWF::Request](https://dev.yorhel.nl/tuwf/man/request)
- [TUWF::Response](https://dev.yorhel.nl/tuwf/man/response)
- [TUWF::Validate](https://dev.yorhel.nl/tuwf/man/validate)
- [TUWF::XML](https://dev.yorhel.nl/tuwf/man/xml)

Documentation for each of these modules is provided in a .pod file along
their .pm implementations. Check out the documentation of the main TUWF
module for a general introduction.

More information is available on the homepage at
[https://dev.yorhel.nl/tuwf](https://dev.yorhel.nl/tuwf).


## Optional dependencies

(Perl core modules not listed)

- [DBI](https://metacpan.org/release/DBI) - for SQL functionality (TUWF::DB)
- [FCGI](https://metacpan.org/release/FCGI) - to run in a FastCGI environment
- [HTTP::Server::Simple](https://metacpan.org/release/HTTP-Server-Simple) - to run the standalone HTTP server
- [JSON::XS](https://metacpan.org/release/JSON-XS) - for JSON requests & responses
- [PerlIO::gzip](https://metacpan.org/release/PerlIO-gzip) - for output compression


## Installing

From CPAN:

```
  cpan TUWF
```

From the repo (using cpanminus):

```
  cpanm .
```

Manually:

```
  perl Build.PL
  ./Build
  ./Build install
```


## Contact

Homepage: [https://dev.yorhel.nl/tuwf](https://dev.yorhel.nl/tuwf)

Git: [https://code.blicky.net/yorhel/tuwf](https://code.blicky.net/yorhel/tuwf)

Email: projects@yorhel.nl