{"id":15971978,"url":"https://github.com/spimy/pengyou","last_synced_at":"2026-02-02T07:08:50.297Z","repository":{"id":244125800,"uuid":"811855444","full_name":"Spimy/pengyou","owner":"Spimy","description":null,"archived":false,"fork":false,"pushed_at":"2024-12-29T07:29:11.000Z","size":1271,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-12T15:46:53.484Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://pengyou.spimy.dev","language":"Svelte","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Spimy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-07T12:47:32.000Z","updated_at":"2024-12-29T07:29:15.000Z","dependencies_parsed_at":"2025-02-12T15:44:29.931Z","dependency_job_id":"cf7e3765-6c46-41bb-9ec5-f2ff27db0e27","html_url":"https://github.com/Spimy/pengyou","commit_stats":null,"previous_names":["spimy/pengyou"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Spimy%2Fpengyou","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Spimy%2Fpengyou/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Spimy%2Fpengyou/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Spimy%2Fpengyou/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Spimy","download_url":"https://codeload.github.com/Spimy/pengyou/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247464232,"owners_count":20942970,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-07T20:41:29.282Z","updated_at":"2026-02-02T07:08:45.250Z","avatar_url":"https://github.com/Spimy.png","language":"Svelte","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- PROJECT LOGO --\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca\u003e\n    \u003cimg src=\"https://github.com/Spimy/pengyou/assets/23694752/9914cf77-8fc7-412d-b104-2d61d6c6bab8\" alt=\"Pengyou's Logo\" height=\"150\"\u003e\n  \u003c/a\u003e\n  \u003ch3\u003ePengYou\u003c/h3\u003e\n  \u003cp\u003eYour best friend for all things budgeting\u003c/p\u003e\n\u003c/div\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#built-with\"\u003eBuilt With\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#acknowledgments\"\u003eAcknowledgments\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#fun-fact\"\u003eFun Fact\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n\n## About The Project\n\n**PengYou** is a solution project for ImagineHack 2024 by Team Dessert Spoons, it is a platform targetting the people that are interested in improving their financial situation.\n\n### Problem Statement\n\n**There is a need** for an app for people requiring budgeting advice where they can learn day to day **tips and tricks** and **practical budgeting**.\n\n### Our Mission\n\nThe mission of **PengYou** is to encourage people to form good budgeting habits by making budgeting more friendly to them. We believe in the importance of forming good habits, thus we have introduced a reward system using a virtual pet to motivate people to actively take control of their financial lives.\n\n### Values\n\n**PengYou** will provide a significant amount of value for its users:\n\n1. Raise Awareness\n2. Tool for budgeting\n3. Reduced Stress\n4. Areas to cut off\n5. Goal Setting\n6. Long-term Security\n7. Practical Learning\n8. Confidence Builder\n\n### SDG Goals\n\n**PengYou** involves the following Sustainable Development Goals:\n\n\u003cdiv style=\"display: flex; justify-content: space-evenly;\"\u003e\n  \u003ca href=\"https://sdgs.un.org/goals/goal1\"\u003e\n    \u003cimg src=\"https://upload.wikimedia.org/wikipedia/commons/thumb/5/50/Sustainable_Development_Goal_01NoPoverty.svg/1200px-Sustainable_Development_Goal_01NoPoverty.svg.png\"  height=\"100\" alt=\"Goal 1 : No Poverty\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://sdgs.un.org/goals/goal4\"\u003e\n    \u003cimg src=\"https://upload.wikimedia.org/wikipedia/commons/thumb/9/9d/Sustainable_Development_Goal_04QualityEducation.svg/1200px-Sustainable_Development_Goal_04QualityEducation.svg.png\" height=\"100\" alt=\"Goal 4 : Quality Education\"\u003e\n  \u003c/a\u003e  \n  \u003ca href=\"https://sdgs.un.org/goals/goal8\"\u003e\n    \u003cimg src=\"https://upload.wikimedia.org/wikipedia/commons/thumb/b/bd/Sustainable_Development_Goal_08DecentWork.svg/800px-Sustainable_Development_Goal_08DecentWork.svg.png\" height=\"100\" alt=\"Goal 8 : Decent work and economic growth\"\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\u003c/ul\u003e\n\n## Built With\n\n- [SvelteKit](https://kit.svelte.dev/)\n- [Lucia](https://lucia-auth.com/)\n- [ApexCharts](https://apexcharts.com/)\n- [MongoDB](https://www.mongodb.com/)\n- [TypeScript](https://www.typescriptlang.org/)\n\n## Installation\n\nThere are some prerequisites that need to be set up:\n\n1. Have a running MongoDB server which can be downloaded from [here](https://www.mongodb.com/try/download/community).\n2. Clone this repository by running `git clone https://github.com/Spimy/pengyou.git`.\n\n### Development\n\n1. Navigate into the folder.\n2. Run `pnpm install` to download the dependencies.\n3. Setup environment variables following [.env.example](.env.example).\n4. Run `pnpm run dev` to run the app in dev mode.\n\n### Production\n\n1. Navigate into the folder.\n2. Run `pnpm install` to install the dependencies.\n3. Setup environment variables following [.env.example](.env.example).\n4. Run `pnpm run build` to build the project.\n5. Run `pnpm prune --prod` to delete all dev dependencies.\n6. Run `pnpm run start` to start the built project.\n\nYou can then reverse proxy into the built project using a web server such as [NGINX](https://nginx.org/en/), [Traefik](https://traefik.io/), etc.\n\n### Docker\n\nTo avoid dependency and build issues, the project has been dockerized.\n\nThis automatically sets the adapter to use node adapter for SvelteKit.\n\nThis will set up a local MongoDB server and have the SvelteKit app connect to it. If the MongoDB server fails to start, the SvelteKit app will not start. You do not need to set the MongoDB URL in your `.env` file.\n\nBe sure to have docker installed on your machine first:\n\n```bash\nsudo apt-get update\nsudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin\n```\n\n1. Build the image: `docker compose build`.\n2. Then run the image in a container: `docker compose up`.\n\n## Acknowledgments\n\nTeam Dessert Spoons members:\n\n- [William Law Hong Waye (Spimy)](https://github.com/Spimy) - Lead Programmer\n- [Alex Chee Kai Hong](https://github.com/datgai) - UI Designer\n- [Lanisha (l4n1skyy)](https://github.com/l4n1skyy) - Graphics Designer\n- [Lai Yung Wei](https://github.com/LaiYW11) - Frontend Developer\n- [Joshua Edwin Rene Bonham](https://github.com/JBBru-helloworld) - Lead Researcher and Presenter\n\nThe aforementioned roles are the main role of each member. It is to be noted that we helped and contributed to each other's tasks, especially the frontend. This was to ensure that we have a consistent UI and thus a good UX by working closely and directly with the Graphics and UI designers.\n\n## Fun Fact\n\nThe name **Dessert Spoons** is an attempt at [rickrolling](https://www.youtube.com/shorts/JbeXb0YWQxo) everyone at the Hackathon.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspimy%2Fpengyou","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspimy%2Fpengyou","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspimy%2Fpengyou/lists"}