{"id":26219414,"url":"https://github.com/hngprojects/hng_boilerplate_php_laravel_web","last_synced_at":"2026-01-26T13:06:53.077Z","repository":{"id":243386922,"uuid":"807787119","full_name":"hngprojects/hng_boilerplate_php_laravel_web","owner":"hngprojects","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-03T03:33:34.000Z","size":2922,"stargazers_count":144,"open_issues_count":46,"forks_count":63,"subscribers_count":5,"default_branch":"dev","last_synced_at":"2025-03-12T14:17:53.017Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Blade","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hngprojects.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-29T19:13:54.000Z","updated_at":"2025-03-12T02:19:23.000Z","dependencies_parsed_at":"2024-06-08T14:43:32.154Z","dependency_job_id":"a547607e-9b23-4531-931a-d457e1bcf85a","html_url":"https://github.com/hngprojects/hng_boilerplate_php_laravel_web","commit_stats":null,"previous_names":["hngprojects/hng_boilerplate_php_laravel_web"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/hngprojects/hng_boilerplate_php_laravel_web","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hngprojects%2Fhng_boilerplate_php_laravel_web","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hngprojects%2Fhng_boilerplate_php_laravel_web/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hngprojects%2Fhng_boilerplate_php_laravel_web/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hngprojects%2Fhng_boilerplate_php_laravel_web/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hngprojects","download_url":"https://codeload.github.com/hngprojects/hng_boilerplate_php_laravel_web/tar.gz/refs/heads/dev","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hngprojects%2Fhng_boilerplate_php_laravel_web/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28778802,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-26T11:46:04.308Z","status":"ssl_error","status_checked_at":"2026-01-26T11:46:02.664Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-12T14:17:55.026Z","updated_at":"2026-01-26T13:06:53.062Z","avatar_url":"https://github.com/hngprojects.png","language":"Blade","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [hng_boilerplate_php_web] Integration Documentation\n\n## Overview\n\n[Description]\n\n## Dependencies (Dev)\n- PHP\n- Laravel\n\n## Getting Started\n\nBefore you begin, ensure you have the following installed on your machine:\n\n- [PHP](https://www.php.net/)\n- [Git](https://www.php.net/)\n\n## Contribution Guide\n\n## Getting Started\n\n#### If you don't have git on your machine, [install it](https://docs.github.com/en/get-started/quickstart/set-up-git).\n\n## Fork this repository\n\nFork this repository by clicking on the fork button on the top of this page.\nThis will create a copy of this repository in your account.\n\n## Clone the repository\n\n\u003cimg align=\"right\" width=\"300\" src=\"https://firstcontributions.github.io/assets/Readme/clone.png\" alt=\"clone this repository\" /\u003e\n\nNow clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the _copy to clipboard_ icon.\n\nOpen a terminal and run the following git command:\n\n```bash\ngit clone https://github.com/hngprojects/hng_boilerplate_php_web.git\n```\n## Create a branch\n\nChange to the repository directory on your computer (if you are not already there):\n\n```bash\ncd first-contributions\n```\n\nNow create a branch using the `git switch` command:\n\n```bash\ngit switch -c your-new-branch-name\n```\nFor example:\n\n```bash\ngit switch -c add-alonzo-church\n```\n\n### Make Changes\n\nMake your changes to the codebase. Ensure your code follows the project's coding standards and guidelines.\n\n### Run Tests\n\nRun the existing tests to ensure your changes do not break anything. If you added new functionality, write corresponding tests.\n\n```sh\nphp artisan test\n```\n\n## commit those changes\n\nNow open `Contributors.md` file in a text editor, add your name to it. Don't add it at the beginning or end of the file. Put it anywhere in between. Now, save the file.\n\n\u003cimg align=\"right\" width=\"450\" src=\"https://firstcontributions.github.io/assets/Readme/git-status.png\" alt=\"git status\" /\u003e\n\nIf you go to the project directory and execute the command `git status`, you'll see there are changes.\n\nAdd those changes to the branch you just created using the `git add` command:\n\n## Push changes to GitHub\n\nPush your changes using the command `git push`:\n\n```bash\ngit push -u origin your-branch-name\n```\n\nreplacing `your-branch-name` with the name of the branch you created earlier.\n\n\u003cdetails\u003e\n\u003csummary\u003e \u003cstrong\u003eIf you get any errors while pushing, click here:\u003c/strong\u003e \u003c/summary\u003e\n\n- ### Authentication Error\n     \u003cpre\u003eremote: Support for password authentication was removed on August 13, 2021. Please use a personal access token instead.\n  remote: Please see https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/ for more information.\n  fatal: Authentication failed for 'https://github.com/\u003cyour-username\u003e/first-contributions.git/'\u003c/pre\u003e\n  Go to [GitHub's tutorial](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) on generating and configuring an SSH key to your account.\n\n\u003c/details\u003e\n\n## Submit your changes for review into Staging\n\nIf you go to your repository on GitHub, you'll see a `Compare \u0026 pull request` button. Click on that button.\n\n\u003cimg style=\"float: right;\" src=\"https://firstcontributions.github.io/assets/Readme/compare-and-pull.png\" alt=\"create a pull request\" /\u003e\n\nNow submit the pull request.\n\n\u003cimg style=\"float: right;\" src=\"https://firstcontributions.github.io/assets/Readme/submit-pull-request.png\" alt=\"submit pull request\" /\u003e\n\nSoon your changes will be merged into the staging branch of this project. You will get a notification email once the changes have been merged.\n\n\n## Setting Up the Environment\n\nThis guide provides step-by-step instructions to help any developer, regardless of their familiarity with Laravel, run the app and test the feature implemented in the PR.\n\n- You should have WSL installed on your windows PC or use a linux distribution(Recommended but not compulsory).\n- Have Git installed\n- Have PHP 8.1 or higher, PostgreSQL 15 or higher and Composer installed(Mandatory)\n- Have Docker installed(Recommended but not compulsory).\n- If not using docker, install WAMP, XAMPP or Laragon\n\n## Cloning the repository\n\n```\ngit clone https://github.com/hngprojects/hng_boilerplate_php_laravel_web.git\ncd hng_boilerplate_php_laravel_web\ngit checkout scaffold\n```\n\n## Setting up using docker\n\n### Set Up Environment Variables\nCopy the example environment file to create your own `.env` file in the project folder:\n    ```\n    cp .env.example .env\n    ```\nOpen the `.env` file in a text editor and update the following variables:\n    - `DB_CONNECTION` (e.g., `pgsql`)\n    - `DB_HOST` (e.g., `127.0.0.1`)\n    - `DB_PORT` (e.g., `5432`)\n    - `DB_DATABASE` (your database name)\n    - `DB_USERNAME` (your database username)\n    - `DB_PASSWORD` (your database password)\n\n### Generate Application Key\nRun the following command to generate a new application key:\n    `sail artisan key:generate` or `php artisan key:generate`\n\nRun the following command to generate a new JWT secret key:\n    `sail artisan jwt:secret` or `php artisan jwt:secret `\n\n### Start the Development Server\n\n- Run `composer install`\n- Run `sail artisan migrate --seed` to migrate the tables and seed them, in another terminal.\n- \nRun the following command to start the Laravel development server:\n    `sail artisan up`\nThe application will be available at http://127.0.0.1/ or http://localhost/.\n\n## Setting up without docker\n\nMove your project folder into the www folder in WAMP, XAMPP or Laragon\n\n### Set Up Environment Variables\nCopy the example environment file to create your own `.env` file in the project folder:\n    `\n    cp .env.example .env\n    `\nRun the following command to generate a new JWT secret key:\n   `php artisan jwt:secret `\n\nOpen the `.env` file in a text editor and update the following variables:\n    - `DB_CONNECTION` (e.g., `pgsql`)\n    - `DB_HOST` (e.g., `pgsgl`)\n    - `DB_PORT` (e.g., `5432`)\n    - `DB_DATABASE` (your database name)\n    - `DB_USERNAME` (your database username)\n    - `DB_PASSWORD` (your database password)\n\n### Generate Application Key\nRun the following command to generate a new application key:\n    `php artisan key:generate`\n\n### Start the Development Server\n\n- Run `composer install`\n- Run `php artisan migrate --seed` to migrate the tables and seed them\n- \nRun the following command to start the Laravel development server:\n    `php artisan serve`\nThe application will be available at http://127.0.0.1:8000/ or http://localhost/.\n\n\n### 6. Verify the Setup\n\nOpen your browser and navigate to `http://localhost:8000/api/v1/` to verify that the application is running correctly.\n\n## Additional Resources\n- [PHP](https://www.php.net/docs.php)\n- [Laravel](https://laravel.com/docs/11.x)\n\nBy following these steps, you should have your Laravel application up and running. If you encounter any issues, please refer to the documentation of the respective tools or seek help from the community.\n\n## API Endpoints\n\nAll API endpoints can be referenced in the [API Reference](API_REFERENCE.md) document.\n\n## Versioning\n\nThis project is versioned to ensure backward compatibility and easy maintenance. The current version is [version].\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhngprojects%2Fhng_boilerplate_php_laravel_web","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhngprojects%2Fhng_boilerplate_php_laravel_web","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhngprojects%2Fhng_boilerplate_php_laravel_web/lists"}