{"id":16982255,"url":"https://github.com/maxpatiiuk/small-retail-management","last_synced_at":"2026-04-14T04:31:51.669Z","repository":{"id":195289139,"uuid":"662324349","full_name":"maxpatiiuk/small-retail-management","owner":"maxpatiiuk","description":"A simple-to-use dashboard for tracking revenue, expenses, and salaries for every employee of your small business. Gain insights, see trends, make informed decisions, and streamline your retail business.","archived":false,"fork":false,"pushed_at":"2023-12-03T22:28:53.000Z","size":602,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-11T10:37:37.293Z","etag":null,"topics":["firebase","firestore","nextjs","react","retail","small-business"],"latest_commit_sha":null,"homepage":"https://max.patii.uk/projects/small-retail-management","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maxpatiiuk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2023-07-04T22:03:15.000Z","updated_at":"2023-10-09T03:27:09.000Z","dependencies_parsed_at":"2023-10-28T18:29:26.759Z","dependency_job_id":"a8b030c2-486d-41f7-b971-e67b55c23b5e","html_url":"https://github.com/maxpatiiuk/small-retail-management","commit_stats":null,"previous_names":["maxxxxxdlp/small-retail-management","maxpatiiuk/small-retail-management"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/maxpatiiuk/small-retail-management","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxpatiiuk%2Fsmall-retail-management","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxpatiiuk%2Fsmall-retail-management/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxpatiiuk%2Fsmall-retail-management/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxpatiiuk%2Fsmall-retail-management/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maxpatiiuk","download_url":"https://codeload.github.com/maxpatiiuk/small-retail-management/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxpatiiuk%2Fsmall-retail-management/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31782736,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-14T02:24:21.117Z","status":"ssl_error","status_checked_at":"2026-04-14T02:24:20.627Z","response_time":153,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["firebase","firestore","nextjs","react","retail","small-business"],"created_at":"2024-10-14T02:07:46.659Z","updated_at":"2026-04-14T04:31:51.654Z","avatar_url":"https://github.com/maxpatiiuk.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Small Retail Management\n\nA simple-to-use dashboard for tracking revenue, expenses, and salaries for every\nemployee of your small business. Gain insights, see trends and make informed\ndecisions.\n\n[Project description and screenshots](https://max.patii.uk/projects/small-retail-management)\n\n[Video demo](https://www.youtube.com/watch?v=NjbcGXO9c3g)\n\n## Features\n\n- Conveniently enter data for the day or entire week from your phone or desktop\n- See total revenue, expenses and salary for each employee for the month, year\n  or all time\n- Easily jump between dates to see historical data\n- Add employees, set revenue share percentage and base salary - total salary\n  will be calculated automatically\n\n## Installation\n\n1. Clone this repository:\n\n   ```sh\n   git clone https://github.com/maxpatiiuk/small-retail-management\n   ```\n\n2. Install dependencies:\n\n   ```sh\n   npm i\n   ```\n\n3. [Create a Firebase project and a Firestore database](https://firebase.google.com/docs/firestore/quickstart?hl=en\u0026authuser=0).\n\n4. Use security rules in [./firestore.rules](./firestore.rules) for the\n   Firestore database. Modify the `isAuthenticated` function to match your\n   security needs - for example allow only users with certain email addresses to\n   access your application.\n\n5. [Generate your Firebase config object](https://firebase.google.com/docs/web/learn-more?authuser=0#config-object).\n\n6. Copy [./example.env.local](./example.env.local) into `.env.local` and fill it\n   in with values generated in the previous step.\n\n7. [Enable Firebase authentication and enable Google authentication provider](https://firebase.google.com/docs/auth/web/google-signin?authuser=0\u0026hl=en#before_you_begin).\n\n8. [Enable daily and weekly backups of the database](https://firebase.google.com/docs/firestore/backups)\n\n## Development\n\n```zsh\nnpm run dev # start development server\n```\n\nThis would start the development server at\n[http://locahlost:3000](http://locahlost:3000).\n\n## Production\n\n```zsh\nnpm run build # begin the build process\nnpm run start # start production server\n```\n\nThis would start the production server at\n[http://locahlost:3000](http://locahlost:3000).\n\nAfterward, you can deploy this site at [https://vercel.com](https://vercel.com).\n\nAlternatively, you can configure a reverse proxy (e.x Nginx) that would handle\nthe SSL certificate and forward the requests to port 80, which should be made\nexternally available.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxpatiiuk%2Fsmall-retail-management","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaxpatiiuk%2Fsmall-retail-management","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxpatiiuk%2Fsmall-retail-management/lists"}