otsch / find-a-pr Goto Github PK

This is the official repository for Find A PR. Find A PR is a platform that curates a list of issues for Laravel-based repositories to help developers find projects to make their first open-source contributions to.

The following tools are required in order to start the installation and run the project locally.

• PHP 8.1
• Composer
• Valet

Here is how you can run the project locally:

1. Clone this repo

   git clone https://github.com/ash-jc-allen/find-a-pr.git

2. Go into the project root directory

   cd find-a-pr

3. Copy .env.example file to .env file

   cp .env.example .env

4. Create database find_a_pr (you can change database name)

5. Go to .env file

   • set database credentials (DB_DATABASE=find_a_pr, DB_USERNAME=root, DB_PASSWORD=)

   Make sure to follow your database username and password

6. Install PHP dependencies

   composer install

7. Generate app key

   php artisan key:generate

8. Install NPM dependencies

   npm install

9. Build assets using NPM

   npm run dev

10. Run server

    php artisan serve