noahheck / piglet

Help families meet their goals

Piglet

Helping families meet their goals

Contributing

Piglet is happy to receive contributions any way they come. Bug reports, feature requests, and code contributions are all welcome and appreciated.

Please note that all code contributions to the project will be accepted under the project license. If you would like to submit your contribution under a different license, it will not be accepted.

Dependencies

Piglet is a pretty standard Laravel application. In order to build and run, you will need:

• git
• PHP 7.2+
• composer
• MySQL (Maria DB should work just as well, if preferred)
• SQLite
• node 8+
• npm 3.5+

Note that Piglet has only ever officially been tested to develop and run on Linux. If you're having trouble installing the dependencies, Laravel Homestead should provide a viable development environment.

Installation

Clone the repository and install the project dependencies:

git clone [email protected]:noahheck/piglet piglet

cd piglet

composer install

npm install

Copy the .env.example file to .env, then generate a Laravel application key:

cp .env.example .env

./artisan key:generate

Use your text editor to change the relevant values to suit your environment, including:

• DB_DATABASE
• DB_USERNAME
• DB_PASSWORD

You might also wish to configure your environment with appropriate MAIL parameters if you want to send emails. See the Laravel documentation.

Execute the database migrations:

./artisan migrate

Running the Application

Start the Artisan development server:

./artisan serve

Open another terminal in the project root and ask node to compile the javascript resources and watch for changes:

npm run watch

Open your web browser and navigate to: http://localhost:8000 (probably, your port may be different).

piglet's Issues

Add a "Back to top" button on the CFP

Age calculation for Contacts is incorrect on day of birthday

Family member born today (2022-01-22) in 2015 should be shown as 7 years old, but is showing as 6 instead. Probably a timezone difference, but not sure)

Add CFP month to the merchants show view data table

It's confusing to see 3 expenses for February when the expenditures actually occurred in March. Adding the CFP month should help clear up the confusion.

Figure out the ordering of the events in the event index screen

Allow families to be archived

• Archive family screen accessible from the Edit Family screen
• Remove archived families from the home screen carousel
• All families view (including archived families) accessible from the main Home screen (including from the default "Create Family" screen if no access to any families has been established)
• Unarchive family from the Edit Family screen
• Verify the family is not archived in the daily calendar email process
• Help pages

Add a screen to help with projecting recurring expense amounts

Do this based on the same expense's actual values for the last couple months, as well as the same time period for the prior year

Collapse the cfp home screen year options by default

It's cluttered and overwhelming to see so many options at one time when navigating to the CFP of choice. Collapse the year options for all except the current year and allow the user to expand their choice of year options.

Clean up (abstract ?) image thumbnail creation from User class

Standard strategy around uploaded photos (?) -

Max 500 px for main image
Max 200 px for thumbnail
Max 50 px for icon size

Make sure all images are output using the correct size

Provide a way to navigate the calendar more efficiently

It sucks to have to click the forward button 12 times to get to the same month next year (e.g., for scheduling next year's annual exam).

Expense groups specified as cash should be all be accounted for in the monthly totals

Protect signup process from spam bots

Probably use this library: https://github.com/spatie/laravel-honeypot

The time picker in the calendar isn't working on Firefox mobile

Add totals to Recurring Expense and Merchant show screens

Calendar popup goes behind breadcrumb bar

Saw this on the piggy bank contribution form screen

Improve the recurring expenses show screen

Add a chart showing the expenses and the amounts by year

This charting will help with accomplishing #19.

Update the CFP Recurring Expense form view to look better

Several of the fields are read-only so there's really no reason for them to be form fields at all. Making them labels will make it look better.

Also, make sure to provide a link (open in a new window/tab) to the Recurring Expense's view. This will accomplish what I wanted with #19.

Need to create some kind of task scheduling/reminding functionality

I want to be reminded every year that in July I have to have the sprinkler backflow testing guy test our system.

I also want to be reminded to include the registration for the pickup in the Cash Flow Plan for July.

I need a way to add and view these types of recurring tasks and expenses so I remember to get them done appropriately.

Compile production assets

See if I can do the same thing I did here

Export calendar

I really want a way to show my piglet calendar in my other calendar apps.

Try out a condensed view of Expense Groups and Recurring Expenses in the CFP

Todos don't order properly across years

January 2022 todos are displayed above 2021 todos:

Scroll to top button is goofed if family is archived or in support mode

Show navigation to each main section within a CFP

It sucks having to scroll down to each section. I can add links to the sidebar to scroll to each section easily (or take to the appropriate page, maybe?)