4ee90caaec706a6a4531c7c09c39aa242fe74409
Krzysztof Sikorski Initialise repository

Krzysztof Sikorski authored 11 months ago

1) # Nexus Archive
2) 
3) The <q>Nexus Archive</q> website, based on Symfony framework.
4) 
Krzysztof Sikorski Fix spelling in readme file

Krzysztof Sikorski authored 11 months ago

5) ## Licence
Krzysztof Sikorski Initialise repository

Krzysztof Sikorski authored 11 months ago

6) 
7) This project is licensed under [European Union Public Licence (EUPL)][EUPL].
8) 
Krzysztof Andrzej Sikorski Code cleanup: reformat READ...

Krzysztof Andrzej Sikorski authored 5 months ago

9) For convenience an English text of the licence is included
Krzysztof Andrzej Sikorski Add list of repository mirr...

Krzysztof Andrzej Sikorski authored 5 months ago

10) in [LICENSE.txt](./LICENSE.txt) file.
11) 
12) ## Repositories
13) 
14) Source code is primarily hosted
15) on [my private Git server](https://git.zerozero.pl/nexus-archive), but for
16) convenience and redundancy it is also mirrored to a few popular code hosting
17) portals:
18) 
19) - [Gitlab mirror](https://gitlab.com/krzysztof-sikorski/nexus-archive)
20) - [GitHub mirror](https://github.com/krzysztof-sikorski/nexus-archive)
21) - [Launchpad mirror](https://git.launchpad.net/nexus-archive)
Krzysztof Sikorski Initialise repository

Krzysztof Sikorski authored 11 months ago

22) 
Krzysztof Sikorski Add installation & deployme...

Krzysztof Sikorski authored 10 months ago

23) ## Installation and deployment
24) 
Krzysztof Andrzej Sikorski Code cleanup: reformat READ...

Krzysztof Andrzej Sikorski authored 5 months ago

25) This is a standard Symfony-based web application, requiring only a standard
26) software stack of:
Krzysztof Sikorski Add installation & deployme...

Krzysztof Sikorski authored 10 months ago

27) 
28) - an http server (e.g. Nginx)
Krzysztof Andrzej Sikorski Code cleanup: reformat READ...

Krzysztof Andrzej Sikorski authored 5 months ago

29) - PHP binaries and some standard extensions (
Krzysztof Andrzej Sikorski Add list of repository mirr...

Krzysztof Andrzej Sikorski authored 5 months ago

30)   see [composer.json file](./composer.json) for details)
Krzysztof Andrzej Sikorski Code cleanup: reformat READ...

Krzysztof Andrzej Sikorski authored 5 months ago

31) - [Composer][Composer] tool (for fetching and installing third-party PHP
32)   libraries)
Krzysztof Sikorski Add installation & deployme...

Krzysztof Sikorski authored 10 months ago

33) - a relational database server supporting SQL language (e.g. PostgreSQL)
34) 
Krzysztof Andrzej Sikorski Code cleanup: reformat READ...

Krzysztof Andrzej Sikorski authored 5 months ago

35) You can find some generic advice in Symfony documentation,
36) in [installation][SymfonyInstallation]
Krzysztof Sikorski Add installation & deployme...

Krzysztof Sikorski authored 10 months ago

37) and [deployment][SymfonyDeployment] chapters.
38) 
Krzysztof Andrzej Sikorski Code cleanup: reformat READ...

Krzysztof Andrzej Sikorski authored 5 months ago

39) The application was only tested on PostgreSQL, but it should theoretically work
40) on any database engine that is supported by Doctrine library.
41) Check [Doctrine documentation][DoctrineVendors] for details.
Krzysztof Sikorski Add installation & deployme...

Krzysztof Sikorski authored 10 months ago

42) 
Krzysztof Andrzej Sikorski Code cleanup: reformat READ...

Krzysztof Andrzej Sikorski authored 5 months ago

43) On Linux Mint (and probably also Ubuntu or Debian) you can use following
44) commands to install required system packages:
Krzysztof Sikorski Add installation & deployme...

Krzysztof Sikorski authored 10 months ago

45) 
46) ```shell
47) sudo apt-get install php-cli php-fpm postgresql # basic packages
48) sudo apt-get install php-xml php-mbstring php-intl php-xml # required or recommended by Symfony
49) sudo apt-get install php-pgsql # required by application design
50) ```
51) 
Krzysztof Andrzej Sikorski Document worker commands in...

Krzysztof Andrzej Sikorski authored 5 months ago

52) Remember to also configure periodic execution of following console commands
53) (e.g. via cron jobs or systemd timers):
54) 
55) - `bin/console app:worker:parser` for parsing submitted data
56) - `bin/console app:worker:prune-database` for pruning unwanted rows from db
57) 
Krzysztof Andrzej Sikorski Code cleanup: convert confi...

Krzysztof Andrzej Sikorski authored 5 months ago

58) ## Development notes
59) 
60) - some classes are loaded from `var\cache` directory, so you have to
61)   execute `bin/console cache:warmup` to have them available for IDE
62)   autocompletion
63) 
Krzysztof Sikorski Initialise repository

Krzysztof Sikorski authored 11 months ago

64) [EUPL]:
65) https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12