Block1A

Block1A official source repo.

Prerequisites

Make sure the following are installed:

• PHP (recommended: PHP 8.x)
• Composer
• Node.js
• A local web server like XAMPP or Laragon

Setup Instructions

This project is a PHP-based website using Composer for dependency management and Tailwind CSS for styling. The following instructions will guide you through setting up the project on your local machine for development and testing purposes.

1. Clone the repository

   git clone https://github.com/jrwnnnn/re-block1a.git
   cd block1a

2. Install vlucas/phpdotenv

   This is needed to manage environment variables:

   composer require vlucas/phpdotenv

3. Create a .env file in the root directory of the project. It should contain environment-specific variables such as:

   DB_HOST=localhost
   DB_NAME=your_database
   DB_USER=root
   DB_PASS=

4. Ensure the .env file is loaded in your PHP project by including the following in your main file (e.g., index.php or a config file):

   require_once __DIR__ . '/vendor/autoload.php';
   $dotenv = Dotenv\Dotenv::createImmutable(__DIR__);
   $dotenv->load();

5. Install Node dependencies

   In the project folder, run the following command in the terminal to install Node dependencies:

   npm install

6. Run Tailwind CSS

   Compile TailwindCSS by running:

   npm run tailwind

7. Start the website

   • Open your local server (e.g., XAMPP, Laragon).

   • Point it to your project folder.

   • Visit the site at:

     http://localhost/re-block1a/index.php
     

License

This project uses the MIT license. For details, please refer to the LICENSE file.