Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 1.13 KB

contribute.md

File metadata and controls

35 lines (25 loc) · 1.13 KB

General rules

  • Please provide a nice and positive attitude when writing issues. We are all doing this for fun. Please keep it that way 😇
  • Don't create Pull Requests without opening an issue to discuss the benefits and implications.
  • All Pull Requests should be performed on the dev branch.
  • Don't be offended if a feature that you find necessary doesn't get approved. We have to keep a healthy balance between things that provides value to most users and bloating the UI / code.

Frontend development

  • Install Node and NPM
  • Setup a Pico backend to connect to. Either use your installed docker instance ((Install instructions)[./installation.md]) or spin up a local instance with the Backend development bellow
cd front
npm i
npm start

Backend development

  • Install PHP (>= 8.1)
  • Install Composer
  • Setup a database to connect to. Either use the one Pico already uses in Docker / spin up a new Docker image of Postgres / just use sqlite file.
cd back
composer i
cp .env.example .env
# Set FIREFLY_URL and DB_CONNECTION related values
php artisan serve