# Requirements
1. Apache
2. MYSQL
3. Php 8.2+
4. Phpmyadmin (optional)

# Set up steps
## Clone the project
Either use HTTP or SSH to clone the project to where your web projects are served from. 

## Install packages
Run `composer install` to install packages. This requires you to have composer already installed. In case you do not have compose installed, you can install it by following the instructions [here](https://getcomposer.org/download/)

## Set up config files 
The project needs two configuration files *.config.json* and *.database.json*. Sample files are in *config/env* folder. You can set them up as follows:

### .config.json file
This file contains the projects configurations. You can set it up as follows:
1. Make a copy of *.config-sample.json* and rename it to *.config.json*
2. Update *.config.json* with the necessary configurations. 

### .database.json file
This file containes the projects configurations. You can set it up as follows:
1. Make a copy of *.database-sample.json* and rename it to *.database.json*
2. Update *.database.json* with the database credentials

## Set up the database
A startup database exists in the config folder. 
1. Create a local database with the collation **utf8mb4_general_ci**
2. Import the database file to the local database created. You can either import using two methods:
    - Using phpmyadmin UI
    - Using a command `mysql -u root -p <database_name> < db.sql`. Replace `<database_name>` with the actual database name. Make sure you are in the same folder where the sql file is.




