From 89f47a5f67f5ef066fb2fce4a1edc6088b147431 Mon Sep 17 00:00:00 2001 From: Naime Date: Fri, 1 Sep 2023 13:07:17 +0300 Subject: [PATCH 1/6] update readme --- README.md | 86 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 85 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e0578c9..c7f9707 100644 --- a/README.md +++ b/README.md @@ -41,9 +41,93 @@ application is as easy as adding the package name to the composer; - Laravel - Laravel Octane +## Project Setup + +This covers cloning your Laravel project from GitHub, installing necessary dependencies, creating configuration files and running the project. + +## Step 1 : Cloning the project from GitHub Account + +To clone the relevant project from your GitHub account, you use the following command: + +``` +git clone https://github.com/nextdeveloper-nl/platform-v1.git +``` +## Step 2 : Creating the 'composer.json' file and installing dependencies + +Edit the `composer.json` file according to your needs and add the projects dependencies. + + +``` +"repositories": [ + + { + "type": "path", + "url": "../NextDeveloper/...", + "options": + { + "symlink": true + } + } + ... + ] + "require": { ... }, +``` + +In this example\ a local dependency is defined in the `repositories` section, and external dependencies to be fetched from outside sources are specified in the `require` section. + +To create a folder named `NextDeveloper` use the following command: + +``` +mkdir NextDeveloper +cd NextDeveloper +``` +The cloning process from GitHub is performed for the required repositories + +``` +git clone https://github.com/nextdeveloper-nl/generator.git +git clone https://github.com/nextdeveloper-nl/commons.git +git clone https://github.com/nextdeveloper-nl/i18n.git +git clone -b dev https://github.com/nextdeveloper-nl/iam.git +cd .. +cd +``` +After completing the composer.json file. + +``` +composer install +``` +The update the dependencies + +``` +composer update +``` + +## Step 3: Creating the '.env' file and generating an APP_KEY + +Create a .env file in the projects root directory : + +``` +touch env +``` +**Note that:** The .env file is used to store configuration settings. It stores sensitive information(database password,production, test) + +To generate an 'APP_KEY' +``` +php artisan key:generate +``` + +**Note that** This command automatically generates the key setting in the config/app.php file and adds it to the .env file. + +## Running the project + +``` +php artisan serve +``` + ## Running the project Is as simle as: ``` php artisan octane:start -``` \ No newline at end of file +``` + From d530e024c2325fbffa18c21ea367828170882278 Mon Sep 17 00:00:00 2001 From: Naime Date: Fri, 1 Sep 2023 15:51:32 +0300 Subject: [PATCH 2/6] update readme 3 --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c7f9707..97a2cf8 100644 --- a/README.md +++ b/README.md @@ -45,14 +45,14 @@ application is as easy as adding the package name to the composer; This covers cloning your Laravel project from GitHub, installing necessary dependencies, creating configuration files and running the project. -## Step 1 : Cloning the project from GitHub Account +### Step 1 : Cloning the project from GitHub Account To clone the relevant project from your GitHub account, you use the following command: ``` git clone https://github.com/nextdeveloper-nl/platform-v1.git ``` -## Step 2 : Creating the 'composer.json' file and installing dependencies +### Step 2 : Creating the 'composer.json' file and installing dependencies Edit the `composer.json` file according to your needs and add the projects dependencies. @@ -102,7 +102,7 @@ The update the dependencies composer update ``` -## Step 3: Creating the '.env' file and generating an APP_KEY +### Step 3: Creating the '.env' file and generating an APP_KEY Create a .env file in the projects root directory : @@ -118,7 +118,7 @@ php artisan key:generate **Note that** This command automatically generates the key setting in the config/app.php file and adds it to the .env file. -## Running the project +### Running the project ``` php artisan serve From c32dbe55484ce67c96f5c0e3d5e0aaaf18949b66 Mon Sep 17 00:00:00 2001 From: Naime Date: Fri, 1 Sep 2023 22:10:19 +0300 Subject: [PATCH 3/6] last readme update --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 97a2cf8..e29ae10 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ Edit the `composer.json` file according to your needs and add the projects depen ``` "repositories": [ - + ... { "type": "path", "url": "../NextDeveloper/...", @@ -67,10 +67,13 @@ Edit the `composer.json` file according to your needs and add the projects depen { "symlink": true } - } + }\ ... ] - "require": { ... }, + "require": + { + ... + }, ``` In this example\ a local dependency is defined in the `repositories` section, and external dependencies to be fetched from outside sources are specified in the `require` section. From f00f05b2bd42ee2645700a8522d157bd4e391451 Mon Sep 17 00:00:00 2001 From: Naime Date: Fri, 1 Sep 2023 22:11:00 +0300 Subject: [PATCH 4/6] last readme update 2 --- README.md | 136 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 86 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index e29ae10..2e64ad9 100644 --- a/README.md +++ b/README.md @@ -41,90 +41,126 @@ application is as easy as adding the package name to the composer; - Laravel - Laravel Octane -## Project Setup +## Project Setup This covers cloning your Laravel project from GitHub, installing necessary dependencies, creating configuration files and running the project. -### Step 1 : Cloning the project from GitHub Account + ### Step 1 : Cloning the project from GitHub account -To clone the relevant project from your GitHub account, you use the following command: - -``` -git clone https://github.com/nextdeveloper-nl/platform-v1.git -``` -### Step 2 : Creating the 'composer.json' file and installing dependencies + First, clone the Laravel project from GitHub and clone it into your project directory. + Open the terminal: -Edit the `composer.json` file according to your needs and add the projects dependencies. + ``` + git clone https://github.com/nextdeveloper-nl/platform-v1.git + cd + ``` +### Step 2 : Install composer dependencies +Let's use the following command to create the 'composer.json' file in the project. +Open the terminal and navigate to the project directory ``` -"repositories": [ - ... - { - "type": "path", - "url": "../NextDeveloper/...", - "options": - { - "symlink": true - } - }\ - ... - ] - "require": - { - ... - }, + composer init ``` -In this example\ a local dependency is defined in the `repositories` section, and external dependencies to be fetched from outside sources are specified in the `require` section. +With this command, a 'composer.json' file is created and you will be prompted with various questions. -To create a folder named `NextDeveloper` use the following command: + 1. Package name(/) : This is a step where you need to specify a unique name for the package you are creating. '' -> It represents the person and organization creating the package. '' -> It represent the name of the created package. + 2. Description : Package description + 3. Author : It represents the information of the person creating the package + 4. Minimum Stability: Indicantes the stability level of the project. (stable,dev,alpha) + 5. Package Type : Package Type(project,library,laravel-package) + 6. License : Package licence (MIT,GPL,BSD) + 7. Would you like to define your dependencies(require) interactively?(yes/no): This question asks whether you want to define dependencies for the project. If you choose 'yes' you can define dependencies interactively. If you choose 'no' you ca add dependencies later by editing the 'composer.json' file + . Would you like to define your dev dependencies(require-dev) interactively?(yes/no): Development dependencies +Then, ``` -mkdir NextDeveloper -cd NextDeveloper + composer install ``` -The cloning process from GitHub is performed for the required repositories +This command installs the core dependencies of your Laravel project ``` -git clone https://github.com/nextdeveloper-nl/generator.git -git clone https://github.com/nextdeveloper-nl/commons.git -git clone https://github.com/nextdeveloper-nl/i18n.git -git clone -b dev https://github.com/nextdeveloper-nl/iam.git -cd .. -cd + composer update ``` -After completing the composer.json file. +This command updates the changes made in the 'composer.json' file. + +### Step 3 : Creating the '.env' file and generating the application key + + The '.env' file contains the basic configurations setting for your Laravel project. + Open the terminal and navigate to the project directory ``` -composer install + touch .env ``` -The update the dependencies + This command creates the '.env' file. +**Note that:** The .env file is used to store configuration settings. It stores sensitive information(database password,production, test) ``` -composer update + php artisan key:generate ``` +This command creates the APP_KEY. +**Note that** This command automatically generates the key setting in the config/app.php file and adds it to the .env file. -### Step 3: Creating the '.env' file and generating an APP_KEY +### Step 4 : Repository cloning and composer operations + + To clone a repository and include it in the project the following steps are followed: + Navigate to the parent directory of the project in the terminal + ``` + cd .. + mkdir NextDeveloper + cd NextDeveloper + git clone https://github.com/nextdeveloper-nl/generator.git + git clone https://github.com/nextdeveloper-nl/commons.git + git clone https://github.com/nextdeveloper-nl/i18n.git + git clone -b dev https://github.com/nextdeveloper-nl/iam.git + cd .. + cd + ``` + The repository versions used to in the 'require' section of the 'composer.json' file are automatically detected by composer + + ``` + "require": { + ... + "nextdeveloper/commons": "@dev", + "nextdeveloper/generator": "@dev", + "nextdeveloper/i18n": "@dev", + ... + } + ``` -Create a .env file in the projects root directory : + ### Step 5: Adding the repository section + +The 'repositories' section is added to the projects 'composer.json' file as follows: ``` -touch env + "repositories": [ + { + "type": "path", + "url": "../NextDeveloper/your-package", + "options": { + "symlink": true + } + } + ] ``` -**Note that:** The .env file is used to store configuration settings. It stores sensitive information(database password,production, test) -To generate an 'APP_KEY' -``` -php artisan key:generate -``` +**Note That** type: Specifies the repository type and should point to a local directory when 'path' is used. +**Note That** url: Specifies the path to the local direstory. This path should be specified relative to the folder where the projects 'composer.json' file is located. +**Note That** options: It is used to specify extra options. When the 'symlink' options is set to true composer adds the dependency as a symbolic link +**Note That** This method is quite useful for testing packages or dependencies tahtyou develop locally during the development of your project. This way, you can quickly include changes from the local directory into your project. -**Note that** This command automatically generates the key setting in the config/app.php file and adds it to the .env file. +The following command is used for changes in the 'composer.json' file: + + ``` + composer install + composer update + ``` ### Running the project ``` -php artisan serve + php artisan serve ``` ## Running the project From 19099305b9adfeec0b49ea1e1f76a11147b8fa11 Mon Sep 17 00:00:00 2001 From: Naime Date: Fri, 1 Sep 2023 22:16:46 +0300 Subject: [PATCH 5/6] end --- README.md | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 2e64ad9..9b798d2 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ Open the terminal and navigate to the project directory With this command, a 'composer.json' file is created and you will be prompted with various questions. - 1. Package name(/) : This is a step where you need to specify a unique name for the package you are creating. '' -> It represents the person and organization creating the package. '' -> It represent the name of the created package. + 1. Package name(vendor/name) : This is a step where you need to specify a unique name for the package you are creating. 'vendor' -> It represents the person and organization creating the package. 'name' -> It represent the name of the created package. 2. Description : Package description 3. Author : It represents the information of the person creating the package 4. Minimum Stability: Indicantes the stability level of the project. (stable,dev,alpha) @@ -106,28 +106,28 @@ This command creates the APP_KEY. To clone a repository and include it in the project the following steps are followed: Navigate to the parent directory of the project in the terminal - ``` - cd .. - mkdir NextDeveloper - cd NextDeveloper - git clone https://github.com/nextdeveloper-nl/generator.git - git clone https://github.com/nextdeveloper-nl/commons.git - git clone https://github.com/nextdeveloper-nl/i18n.git - git clone -b dev https://github.com/nextdeveloper-nl/iam.git - cd .. - cd - ``` + ``` + cd .. + mkdir NextDeveloper + cd NextDeveloper + git clone https://github.com/nextdeveloper-nl/generator.git + git clone https://github.com/nextdeveloper-nl/commons.git + git clone https://github.com/nextdeveloper-nl/i18n.git + git clone -b dev https://github.com/nextdeveloper-nl/iam.git + cd .. + cd + ``` The repository versions used to in the 'require' section of the 'composer.json' file are automatically detected by composer - ``` - "require": { - ... - "nextdeveloper/commons": "@dev", - "nextdeveloper/generator": "@dev", - "nextdeveloper/i18n": "@dev", - ... - } - ``` + ``` + "require": { + ... + "nextdeveloper/commons": "@dev", + "nextdeveloper/generator": "@dev", + "nextdeveloper/i18n": "@dev", + ... + } + ``` ### Step 5: Adding the repository section From 2816064c1b11e0f7b77a62b41ffa4b778109d5d2 Mon Sep 17 00:00:00 2001 From: Naime Date: Fri, 1 Sep 2023 22:20:02 +0300 Subject: [PATCH 6/6] end 2 --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 9b798d2..f588b80 100644 --- a/README.md +++ b/README.md @@ -146,8 +146,11 @@ The 'repositories' section is added to the projects 'composer.json' file as foll ``` **Note That** type: Specifies the repository type and should point to a local directory when 'path' is used. + **Note That** url: Specifies the path to the local direstory. This path should be specified relative to the folder where the projects 'composer.json' file is located. + **Note That** options: It is used to specify extra options. When the 'symlink' options is set to true composer adds the dependency as a symbolic link + **Note That** This method is quite useful for testing packages or dependencies tahtyou develop locally during the development of your project. This way, you can quickly include changes from the local directory into your project. The following command is used for changes in the 'composer.json' file: