🏢 OnIADE

A web application to track people inside IADE's building. This project was developed for the Project III class of the Creative Technologies course.

Setting Up

If you want to test this project you'll have to do a couple of steps before you can have everything up and running.

Before we can start, make sure that the project is at the root level of your web server, since this project wasn't designed to be run from a sub-folder. You can do this either by setting your web server's document root directory to the project directory or by adding an entry to your hosts file like this:

127.0.0.1	oniade.local

Then you can add a new site to your web server using virtual hosts with the following configuration making sure you put the appropriate values in the ServerName and DocumentRoot fields:

<VirtualHost *:80>
    ServerAdmin admin@oniade.local
    ServerName oniade.local
    DocumentRoot /var/www/oniade
    ErrorLog ${APACHE_LOG_DIR}/error.log
    CustomLog ${APACHE_LOG_DIR}/access.log combined
</VirtualHost>

The first thing you'll have to do is create the database inside of MySQL. This database must be called oniade, since no provision was made for different names. This is as simple as:

DROP DATABASE IF EXISTS oniade;
CREATE DATABASE oniade;

After that has been taken care of you'll need to decide if you want to create a database with empty tables to start fresh or if you just want to try it out. Either way it's just a matter of using either sql/initialize.sql for a blank slate, or sql/example_database.sql for a pre-populated one:

# For a completely blank database use this command:
mysql -u $USER -p oniade < ./sql/initialize.sql

# For a database with some example data use this command:
mysql -u $USER -p oniade < ./sql/example_database.sql

Now that the database is ready to go it's time to setup your environment. First of all make sure you have PHP 7 installed together with preferably Apache. The second dependency that we'll need is Nmap, which is used to scan the network for active devices. Make sure that after you install Nmap that you make it available in your system PATH, since the script expects it there.

After having all of the external dependencies installed it's time to actually setup the PHP dependencies. For this you'll need to have Composer installed on your system. Then it's just a matter of running:

composer install

After the packages finish installing make sure you edit your config/config.php file with the appropriate parameters regarding your database setup and any other options you might want to edit. After that is all done you can start by running your first network scan:

# To run a single network scan:
php ./bin/iadescan

# To leave a little daemon scanning the network every 30 minutes:
# Note: The interval can be changed in the settings.
php ./bin/iadescan -d

If that went well you're now ready to go! Fire up your browser and check out the web application!

Requirements

Even though this is quite a simple project, because of its nature there are quite a few dependencies:

• Apache ^2.4
• PHP ^7.4
• MySQL ^8.0
• Nmap ^7.90
• Composer ^2.0

License

This project is licensed under the MIT License.