bbsv-buhi

Tabulation System for Binibining San Vicente (Buhi, Camarines Sur)

---

Development Setup

Here are the steps to set up the development environment for this project:

1. Download and install XAMPP and NodeJS, if you haven't already.

2. Start Apache and MySQL through XAMPP if not already running.

3. Clone or download this repository to your XAMPP htdocs folder. The final path should be path_to/xampp/htdocs/bbsv-buhi.

4. Copy app/config/database.example.php to app/config/database.php, then modify the database connection settings in the new file.

5. Inside phpMyAdmin, create a MySQL database named bbsv-buhi and import bbsv-buhi.sql into it.

6. Open the terminal and navigate to the project directory bbsv-buhi.

7. Execute the following commands to install the required dependencies:

   npm install

8. Compile and run the development server with hot reloading:

   npm run dev

9. Open your web browser and access http://localhost:5178/bbsv-buhi/ to view the application.

---

Backend Testing

This guide will walk you through the process of testing the backend models.

Prerequisites

Before getting started, ensure that you have Composer installed.

Setup

1. Copy tests/backend/config/test-database.example.php to tests/backend/config/test-database.php, then modify the database connection settings in the new file.

2. Inside phpMyAdmin, create a MySQL database named test-bbsv-buhi and import bbsv-buhi.sql into it.

3. Run the following command to install the required dependencies.

   composer install

   If this command does not work, try running composer update instead.

Writing Tests

To write your tests, simply add your Unit Tests to the tests/backend/unit directory and your Feature Tests to the tests/backend/feature directory.

Running Tests

1. Open a terminal window and navigate to the root directory of the project.

2. Run the following command to execute your tests:

   • all tests

   phpunit

   • unit tests only

   phpunit --testsuite unit

   • feature tests only

   phpunit --testsuite feature

   If phpunit command does not work, try running vendor\bin\phpunit instead.

---

Production Deployment

Here's how to compile the project for production deployment:

1. Generate the public folder by running the following command:

   npm run build

2. Access the application by visiting http://[host_name]/bbsv-buhi, where host_name is the IP address or host name of the server in the network. For example:

   • http://localhost/bbsv-buhi
   • http://192.168.1.99/bbsv-buhi

Admin Dashboard

Access the admin dashboard at http://localhost/bbsv-buhi/app. The default username and password is admin.

Printing Results

For printing results, click the print button in your browser or press CTRL + P, then properly set up the page for printing.