Learn about inXys.

This website is built with a combination of JavaScript and PHP. It uses Node.js for building and packaging. The platform is build with the following major components:

• HTML 5 and CSS 3
• JavaScript ECMAScript 2020
• Bootstrap 5
• PHP 8.3
• node.js 22.13.1
• Enginesis
• PHPUnit

Tasks are run with npm run {task-name} on a command line.

• test: Run the unit tests.
• lint: Perform lint check on JavaScript source files.
• versionup: Increment the minor version number to update the app to the next version.
• build: Bundle the app for production deployment.
• deploy: Copy the bundled production app to the -q server.
• deployemail: Copy the minified email files to the local Enginesis server.
• updatemodules: Copy the shared php and javascript libraries from local repositories (must be installed on your development machine.)
• sitemap: Generate a new site map file rendering dynamic pages.
• clean: Remove all temporary and cache files.

This is a PHP-based website that also uses JavaScript for client-side functionality. To run it locally you need to have a webserver (Apache 2.4) and PHP 8.3 installed on your local development machine. Then load /index.php in a web browser.

All public facing resources are found in the public folder, and this is the folder pointed to by the web server to serve those resources.

Website services are found in the services folder. This is only accessible via PHP since it is outside the public website.

JavaScript unit tests are run with Jest. Run npm test.

PHP unit tests are run with PHPUnit. Run from a command terminal as follows:

cd sitedev/test
sh runtests.sh

The tests run this way generate all output in log files. Check the log files for the results. Or run each test separately, check the file header comments to see the CLI.

Procedure to release the website:

1. Make sure the main branch is up to date.
2. Run the tests: npm test and PHPUnit tests, and verify all tests pass.
3. Run the build npm run build.
4. Copy only the minified files from ./distrib/common to ./public/common. They should overwrite existing minified files.
5. Verify the site by opening a browser to https://inxys-l.net, clear the browser cache, and do a visual inspection of all the pages and verify a user login.
6. Run the deploy script dry run npm run deploy, verify correct file updates, and if OK then run npm run deploy -- --no-dryrun.
7. Rename ./data/deploy.log to today's date ./data/deploy-YYYMMDD.log.
8. Commit the update with the version tag git commit -m "commit message and version".