Hello there! Thanks for considering to contribute to Billy 💚
Billy is still very early in the development phase (refer to ROADMAP), so there may not be a lot of features and there may be bugs 🤐
Refer to the section on creating issues if you would like to report anything!
This is an open source project. Do not harrass people for replies.
- To be a Billy tester in Alpha Track, fill up this form.
- Bug and feature request issues are only prioritised if they are raised by testers in the Internal/Alpha Track.
- PRs not linked to any issues will not be entertained, and auto-closed after 3 days.
Before opening a feature request issue,
- Please check the product ROADMAP document if it is already planned to be implemented.
- In the issue, discuss what you want to be done before implementing anything. This is to keep contributions aligned with the product roadmap and vision.
- Provide sufficient mockups/ screenshots/ flow diagrams whenever applicable.
Please state your device model, and steps to replicate.
If you're a Billy tester, please also email me that the link that of the created issue as well so I can communicate to you more easily if necessary.
- A product landing website
- it should display all the information that is already in the /docs folder.
- it should have a form for users to request for data retrieval or removal
- Improved documentation
- Spellings, rephrasing (for the better) are welcome.
- If you have tried to setup Billy on your own and you find a gap in the setup instructions, feel free to add onto it.
- Mermaid diagrams of how the tech side of things works
- User journey diagrams of how users can use Billy
- GitHub Issue templates
- feel free to add templates for the community to contribute to Billy more easily
- GitHub Actions
- There's E2E Detox tests for Billy, but I haven't integrated it as part of the CICD yet (I also haven't write a lot of it). If you can help to contribute tests or create a workflow that runs the tests & save failing screenshots as artifacts, that will be great.
- For this project, I've also created the GitHub Action to generate Supabase database types, which is used by some devs. You can work on that too if you like!
- Storybook/ equivalent to showcase components
- Be a Billy tester!
⚠️ Billy is only available for Android users on Google Playstore now. If you're on iOS, you can still participate as a tester but you need to install the app locally by cloning the project & setting it up with env variables corresponding to your own Supabase project.
Please create your own Supabase project, and enable email/password authentication. Then set up the tables as follows
create table "Bill" (
deadline timestamp default now() not null,
payee text not null,
amount double not null,
category text,
id bigint not null primary key,
"completedDate" date default now(),
"archivedDate" date default now(),
"deletedDate" date default now(),
"userId" uuid
);
create table "FCMToken" (
id bigint not null primary key,
created_at timestamp default now(),
"deviceId" text,
"userId" uuid,
token text
);
create table "FixedReminder" (
id bigint not null primary key,
created_at timestamp default now(),
"billID" bigint references Bill (id),
value bigint not null,
timeUnit text not null
);
create table "RecurringReminder" (
id bigint not null primary key,
created_at timestamp default now(),
interval numeric not null,
timeUnit ARRAY,
"billID" bigint references Bill (id)
);
Install the node modules & pods
npm i
npx pod-install # if you want to build for ios
Then run 1 of the commands
npm run ios
npm run android
You would need the Supabase project related environment variables as mentioned in .env.sample. You can create your own Supabase project and replace those values.
You need node 16.13.0 for detox that depends on jest-circus runner.