File dev-helper/README.md

Last commit: Sat Jan 28 15:07:58 2023 +0100	Jan Dankert	Better documentation.


     1 # Development Tools
     2 
     3 These files are only necessary **for developers**!
     4  
     5 ## Starting development environment
     6 
     7 In the subdirectory `docker/openrat-dev` exists a docker compose file. Just start it with
     8 
     9 `docker-compose up -d`
    10 
    11 If the command is not found you have to install it. For Debian just type `sudo apt-get install docker-compose`.
    12 
    13 The containers will start up,
    14 - the CMS is available under [localhost:8000](http://localhost:8000).
    15 - the generated page is available under [localhost:8001](http://localhost:8001).
    16 
    17 ## Accessing the database
    18 
    19 The database can be accessed in the docker container
    20 
    21     docker exec -ti openrat-dev_db_1 bash
    22     mysql -u root -p$MYSQL_ROOT_PASSWORD
    23 
    24 Selecting the database and show all CMS tables:
    25 
    26     mysql> use cms;
    27     mysql> show tables;
    28 
    29 ## Creating a release tag
    30 
    31 Usage: `tag-version.sh <version>`. It
    32 
    33 1. updates the file `modules/cms/base/Version.class.php` with the new version
    34 2. creates a git tag
    35 3. updates the file `modules/cms/base/Version.class.php` with the snapshot version
    36 
    37 
    38 ## Updating UI 
    39 
    40 Some files need to be transpiled while developing.
    41 
    42 `update.sh -u http://host/ -w -x <type>`
    43 
    44 Makes the necessary output files writable, then updates them.
    45 
    46 - `-u <url>` the current start url, where the CMS is installed.
    47 - `-w` do not exit, **watch**es the files for modifications (you need `inotify` installed) 
    48 - `-x <type>` where `type` is one of `tpl`,`lang`,`js`,`css`,`xsd` or `all`.
    49   - `tpl`: Transpiles the .tpl.xml files into .php files.
    50   - `lang`: Transpiles the language.yml into seperate files.
    51   - `js`: Minifies the JS files.
    52   - `css`: Starts the LESS compiler
    53   - `xsd`: Updates the XSD for templates.
    54 
    55 You can to the same with [invoking the update via your browser](./update.php). 



Download dev-helper/README.md


History
Sat, 28 Jan 2023 15:07:58 +0100	Jan Dankert	Better documentation.
Sat, 28 Jan 2023 13:26:39 +0100	Jan Dankert	Better documentation.
Sun, 5 Dec 2021 02:03:27 +0100	dankert	Added some documentation.
Tue, 20 Oct 2020 00:52:38 +0200	Jan Dankert	New: A build date in the Version class.
Sat, 22 Aug 2020 02:38:58 +0200	Jan Dankert	Documentation is a good thing.
Mon, 24 Feb 2020 18:36:11 +0100	Jan Dankert	Documentation added.
Sun, 23 Feb 2020 22:35:15 +0100	Jan Dankert	New: Documentation for the template watcher.
Mon, 27 May 2019 21:38:14 +0200	Jan Dankert	New: Readme for development scripts