create-prisma-php-app 1.0.0

package/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024 The Steel Ninja Code - Jefferson Abraham Omier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,158 @@
+# create prisma php app
+
+Prisma-PHP: A Revolutionary Library Bridging PHP with Prisma ORM
+
+## Introduction
+
+`create-prisma-php-app` is an innovative command-line tool designed to seamlessly integrate PHP with Prisma ORM. This tool stands out by offering a unique combination of PHP's robust server-side capabilities with Prisma's modern ORM features. Whether you're building a small project or a large-scale application, `create-prisma-php-app` provides the tools and flexibility needed to elevate your development experience.
+
+## Prerequisites
+
+Ensure your system is equipped with:
+
+- Node.js: Version 16.x or higher [Download Node.js](https://nodejs.org/en/download/)
+- XAMPP: (or any PHP 7.4+ environment) [Download XAMPP](https://www.apachefriends.org/download.html)
+- Composer: Version 2.x or higher [Download Composer](https://getcomposer.org/download/)
+
+## Installation
+
+Installation Steps:
+
+1. Open your terminal.
+2. Run the command:
+
+```bash
+npx create-prisma-php-app
+```
+
+## What's Included
+
+### Prisma ORM and TypeScript Support
+
+- `typescript`: For robust typing and scalability.
+- `@types/node`: Essential Node.js type definitions.
+  `ts-node`: To execute TypeScript scripts in a Node.js environment.
+
+### PHP and Composer Dependencies
+
+- `vlucas/phpdotenv`: For environment variable management.
+- `ramsey/uuid`, `hidehalo/nanoid-php`, `firebase/php-jwt`: For unique ID generation and JWT handling.
+
+### Tailwind CSS Support (Optional)
+
+- `tailwindcss`, `postcss`, `autoprefixer`: Enhance your front-end with Tailwind's utility-first CSS framework.
+
+## Prisma Command
+
+| Command                     | Description                                                                                       |
+| --------------------------- | ------------------------------------------------------------------------------------------------- |
+| `npx prisma init`           | Initializes a new Prisma project by creating the necessary configuration files.                   |
+| `npx prisma migrate dev`    | Creates and applies database migrations in a development environment. Also updates Prisma schema. |
+| `npx prisma migrate reset`  | Resets the database by dropping all data and applying all migrations from scratch.                |
+| `npx prisma migrate deploy` | Applies pending migrations to the database, typically used in a production environment.           |
+| `npx prisma db push`        | Pushes the Prisma schema state to the database without generating migration files.                |
+| `npx prisma db pull`        | Updates the Prisma schema by introspecting the database.                                          |
+| `npx prisma generate`       | Generates Prisma Client based on the current Prisma schema.                                       |
+| `npx prisma studio`         | Opens Prisma Studio, a GUI to view and edit the data in your database.                            |
+| `npx prisma format`         | Formats the Prisma schema file for better readability and consistency.                            |
+
+## PHP Special Commands for Prisma
+
+| Command                  | Description                                    |
+| ------------------------ | ---------------------------------------------- |
+| `npx php generate class` | Generates PHP classes for the database schema. |
+
+## Composer Command
+
+| Command                     | Description                                                                                                      |
+| --------------------------- | ---------------------------------------------------------------------------------------------------------------- |
+| `composer install`          | Installs all PHP dependencies listed in the `composer.json` file.                                                |
+| `composer update`           | Updates all PHP dependencies to the latest versions listed in `composer.json`.                                   |
+| `composer dump-autoload`    | Regenerates the list of all classes that need to be included in the project (autoload file).                     |
+| `composer dump-autoload -o` | Optimizes the autoload by generating a more efficient class map, making it faster to load. Ideal for production. |
+
+## Example Usage
+
+Basic Query Example:
+
+```php
+<?php
+require_once __DIR__ . '/../bootstrap.php';
+use App\Classes\Prisma\Prisma;
+
+$prisma = new Prisma();
+print_r($prisma->User->findMany());
+?>
+```
+
+This code fetches and displays all users from the `User` table.
+
+## Project Structure
+
+```bash
+PrismaPHPProject
+├── prisma                          # Prisma directory
+│   ├── migrations                  # Database migration files
+│   ├── schema.prisma               # Main Prisma schema file
+│   └── seed.js                     # Database seeding script
+├── public                          # Publicly accessible files
+│   ├── index.php                   # Application entry point
+│   ├── css                         # CSS files
+│   ├── js                          # JavaScript files
+│   └── assets                      # Static assets like images, fonts
+├── src                             # Source code
+│   ├── App                         # Core application code
+│   │   ├── Api                     # API endpoints and logic
+│   │   ├── Classes                 # Custom application classes
+│   │   ├── Controller              # MVC controllers
+│   │   ├── Model                   # Data models
+│   │   └── View                    # View templates
+│   ├── Lib                         # Utility functions and libraries
+│   └── [...]
+├── settings                        # Configuration files
+│   ├── paths.php                   # Path settings
+│   └── project-settings.js         # Project settings
+├── vendor                          # Composer dependencies
+├── bootstrap.php                   # Initialization script
+├── .env                            # Environment variables
+├── composer.json                   # Composer configuration
+├── composer.lock                   # Composer lock file
+├── postcss.config.js               # PostCSS configuration (Tailwind CSS)
+├── tailwind.config.js              # Tailwind CSS configuration
+├── tsconfig.json                   # TypeScript configuration
+└── [...]
+```
+
+## Documentation and Resources
+
+- [Node.js](https://nodejs.org/en/docs/)
+- [XAMPP](https://www.apachefriends.org/documentation/)
+- [Composer](https://getcomposer.org/doc/)
+- [Prisma Documentation](https://www.prisma.io/docs/)
+- [PHP Documentation](https://www.php.net/manual/en/)
+- [Tailwind CSS Documentation](https://tailwindcss.com/docs)
+
+## VSCODE Extensions
+
+For a better development experience, consider installing the following Visual Studio Code extensions:
+
+- [Prisma](https://marketplace.visualstudio.com/items?itemName=Prisma.prisma)
+- [PHP Intelephense](https://marketplace.visualstudio.com/items?itemName=bmewburn.vscode-intelephense-client)
+- [PHP Debug](https://marketplace.visualstudio.com/items?itemName=felixfbecker.php-debug)
+- [Tailwind CSS IntelliSense](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss)
+
+## Contributing
+
+Contributions to `create-prisma-php-app` are welcome. If you have any suggestions, bug reports, or pull requests, feel free to open an issue or submit a pull request on the repository.
+
+## License
+
+`create-prisma-php-app` is under the MIT License. See LICENSE for details.
+
+## Author
+
+`create-prisma-php-app` is developed and maintained by [The Steel Ninja Code](https://thesteelninjacode.com/).
+
+## Contact Us
+
+For support, feedback, or inquiries, contact us at [thesteelninjacode@gmail.com](mailto:thesteelninjacode@gmail.com)

package/composer.json

@@ -0,0 +1,23 @@
+{
+  "name": "tsnc/create-prisma-php-app",
+  "license": "MIT",
+  "description": "Prisma-PHP: A Revolutionary Library Bridging PHP with Prisma ORM",
+  "autoload": {
+    "psr-4": {
+      "App\\": "src/app/"
+    }
+  },
+  "authors": [
+    {
+      "name": "Jefferson Abraham Omier",
+      "email": "thesteelninjacode@gmail.com"
+    }
+  ],
+  "require": {
+    "php": "^7.4|^8.0",
+    "vlucas/phpdotenv": "^5.6@dev",
+    "ramsey/uuid": "5.x-dev",
+    "hidehalo/nanoid-php": "1.x-dev",
+    "firebase/php-jwt": "dev-main"
+  }
+}