mirror of
https://github.com/ConnectedHumber/Air-Quality-Web
synced 2024-10-31 03:23:01 +00:00
3.3 KiB
3.3 KiB
Getting Started
To get started, there are 3 main steps:
- Cloning & building the application
- Configuring the application
- Configuration a web server
The process is outlined in detail below.
System Requirements
- Git
- Bash (if on Windows, try Git Bash) - the build script is written in Bash
- PHP 7+ enabled web server
- Nginx + PHP-FPM is recommended
- Apache works too
- MariaDB database with the appropriate table structure pre-loaded
- Node.JS (preferably 10+) + npm 6+ (for installing & building the client-side app code)
- Node.JS
- Composer (for installing server-side dependencies)
- PHP modules:
pdo-mysql
(for the database connection)
- A MariaDB server with a database already setup with the schema loaded into it.
- Find that here: https://github.com/ConnectedHumber/MQTT/blob/master/database/aqdb_V2_no_data.sql (direct link)
- If you have any issue, please get in contact with ConnectedHumber.
Installation
- Start by cloning this repository:
git clone https://github.com/ConnectedHumber/Air-Quality-Web.git
cd
into the root of the cloned repository. Then install the dependencies (these are installed locally):
./build setup setup-dev
- Build the client-side application:
# For development, run this:
./build client
# For production, run this:
NODE_ENV=production ./build client
# If you're actively working on the codebase and need to auto-recompile on every change, run this:
./build client-watch
- Change the ownership to allow your web server user to access the created directory. Usually, the web server will be running under the
www-data
user:
sudo chown -R www-data:www-data path/to/Air-Quality-Web
- Edit
data/settings.toml
to enter your database credentials.
You can edit other settings here too. See settings.default.toml
for the settings you can change, but do not edit settings.default.toml
! Edit data/settings.toml
instead. You'll probably want to give the entire default settings file a careful read.
-
Configure your web server to serve the root of the repository you've cloned if you haven't already. Skip this step if you cloned the repository into a directory that your web server already serves.
-
Disallow public access to the private
data
directory.
In Nginx:
# Put this inside the "server { }" website definition block:
# The "server { }" block can usually be found somewhere in /etc/nginx on Linux machines, and may have a "server_name" directive specifying the domain name it's serving if multiple websites are configured.
location ^~ /path/to/data/directory {
deny all;
}
In Apache:
# Create a file called ".htaccess" with this content inside the data/ directory
Require all denied
- Test the application with an API call. If this returns valid JSON, then you've set it up correctly
http://example.com/path/to/Air-Quality-Web/api.php?action=list-devices
- (Optional) Setup HTTPS:
sudo apt install certbot
# On Nginx:
sudo certbot --nginx --domain example.com
# On Apache:
sudo certbot --apache --domain example.com