Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ash-jc-allen/find-a-pr
The source code for the findapr.io website
https://github.com/ash-jc-allen/find-a-pr
hacktoberfest laravel php
Last synced: 8 days ago
JSON representation
The source code for the findapr.io website
- Host: GitHub
- URL: https://github.com/ash-jc-allen/find-a-pr
- Owner: ash-jc-allen
- License: mit
- Created: 2022-05-18T18:00:07.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T10:28:49.000Z (18 days ago)
- Last Synced: 2024-10-21T15:15:18.213Z (18 days ago)
- Topics: hacktoberfest, laravel, php
- Language: PHP
- Homepage: https://findapr.io
- Size: 1.44 MB
- Stars: 74
- Watchers: 5
- Forks: 37
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
This is the official repository for [Find A PR](https://findapr.io/). 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.
## Requirements
The following tools are required in order to start the installation and run the project locally.
- PHP 8.2
- [Composer](https://getcomposer.org/download/)
## Installation
### Using Sail
> Make sure you have [Sail](https://laravel.com/docs/9.x/sail) installed.
1. Clone this repo
```sh
git clone https://github.com/ash-jc-allen/find-a-pr.git
```
2. Go into the project root directory
```sh
cd find-a-pr
```
3. Copy .env.example file to .env file
```sh
cp .env.example .env
```
4. Install PHP dependencies
```sh
composer install --ignore-platform-reqs
```
5. Boot Sail
```sh
sail up -d
```
6. Generate app key
```sh
sail php artisan key:generate
```
7. Install NPM dependencies
```sh
sail npm install
```
8. Build assets using NPM
```sh
sail npm run dev
```
### Using `artisan serve`
1. Clone this repo
```sh
git clone https://github.com/ash-jc-allen/find-a-pr.git
```
2. Go into the project root directory
```sh
cd find-a-pr
```
3. Copy .env.example file to .env file
```sh
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
```sh
composer install
```
7. Generate app key
```sh
php artisan key:generate
```
8. Install NPM dependencies
```sh
npm install
```
8. Build assets using NPM
```sh
npm run dev
```
10. Run server
```sh
php artisan serve
```