MiguelBa1 / placetogrow

Placetogrow is a robust solution for the 2024 External School Challenge. Administrators can create and manage microsites for invoices, subscriptions, and donations. Users can complete transactions easily and securely through an optimized interface. Built with Laravel, InertiaJs, and Vue 3, adhering to best practices in code quality and CI/CD.

Placetogrow - Microsite Payment Platform

Description

Placetogrow is a platform that allows administrators to create and manage microsites for different types of payments (invoices, subscriptions, donations), and enables users to make payments in a simple and secure manner.

Technologies Used

• PHP 8.2
• Laravel 11.0
• MySQL 8.0
• InertiaJs with Vue 3.4.0 and TypeScript 5.0.2
• Tailwind CSS 3.2.1
• Headless UI 1.7

Installation and Setup

1. Clone the repository:

   git clone https://github.com/MiguelBa1/placetogrow

2. Create the .env file from the .env.example file:

   cp .env.example .env

3. Configure the necessary information in the .env file. Make sure to set the following variables:

   Database Connection

   • DB_CONNECTION
   • DB_HOST
   • DB_PORT
   • DB_DATABASE
   • DB_USERNAME
   • DB_PASSWORD

   Admin User

   • ADMIN_NAME
   • ADMIN_EMAIL
   • ADMIN_PASSWORD

   PlacetoPay Credentials

   • P2P_LOGIN
   • P2P_SECRET_KEY
   • P2P_URL

4. Run composer install to install the dependencies.

5. Run php artisan key:generate to set the APP_KEY value in the .env file.

6. Run php artisan storage:link to make the images available to the application.

7. Run php artisan migrate:fresh --seed to create the database tables and seed the database.

8. Run php artisan serve to start the application.

9. Run npm install and npm run dev to compile the assets.

Note: To use the image manipulation features in the application, the PHP gd extension must be enabled. Please ensure that this extension is enabled on your server.

Creating an Admin User

To access the admin panel, you need an admin user. You can create this user in one of the following ways:

1. By filling in the admin user variables in the .env file as mentioned above.
2. By running the following artisan command:

   php artisan create:admin {name} {email} {password}

This command allows you to directly create an admin user with the specified name, email, and password.

The system commands are defined in the routes/console.php file.