sbrl-github/Air-Quality-Web
1
0
Fork 0
mirror of https://github.com/ConnectedHumber/Air-Quality-Web synced 2024-11-22 06:23:01 +00:00
Code Issues Releases Wiki Activity

README: document system requirements

Browse source
This commit is contained in:
Starbeamrainbowlabs 2019-02-23 20:19:52 +00:00
parent cf5a21d5a2
commit d83e092c5a
Signed by: sbrl
GPG key ID: 1BE5172E637709C2
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -24,6 +24,15 @@ In order to run this program, you'll need the following:
## Getting Started ## Getting Started
The client-side code requires building. Currently, no pre-built versions are available (though these can be provided upon request), so this must be done from source. A build script is available, however, which automates the process - as explained below. The client-side code requires building. Currently, no pre-built versions are available (though these can be provided upon request), so this must be done from source. A build script is available, however, which automates the process - as explained below.
### System Requirements
- PHP-enabled web server (Nginx is recommended, but Apache works too)
- MariaDB database with the appropriate table structure pre-loaded
- PHP 7+
- Node.JS (preferably 10+) + npm 6+ (for installing & building the client-side app code)
- [Composer](https://getcomposer.org/) (for installing server-side dependencies)
- PHP modules:
- `pdo-mysql` (for the database connection)
### Building From Source ### Building From Source
The build script ensures that everything it does will not go outside the current directory (i.e. all dependencies are installed locally). The build script ensures that everything it does will not go outside the current directory (i.e. all dependencies are installed locally).