{"id":21770311,"url":"https://github.com/laplacexd/pan","last_synced_at":"2025-04-13T16:41:00.448Z","repository":{"id":65026341,"uuid":"562188155","full_name":"LaplaceXD/Pan","owner":"LaplaceXD","description":"Pan - An Inventory Management System made with MERN Stack","archived":false,"fork":false,"pushed_at":"2024-06-11T16:18:11.000Z","size":809,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-27T07:35:50.541Z","etag":null,"topics":["css-module","express","formik-yup","javascript","json-as-xlsx","mysql2","nodejs","react-query","reactjs","redis","vite","xlsx"],"latest_commit_sha":null,"homepage":"https://pan-ivory.vercel.app/","language":"JavaScript","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/LaplaceXD.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":"2022-11-05T15:21:46.000Z","updated_at":"2025-01-17T11:09:25.000Z","dependencies_parsed_at":"2024-11-26T14:12:16.489Z","dependency_job_id":null,"html_url":"https://github.com/LaplaceXD/Pan","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LaplaceXD%2FPan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LaplaceXD%2FPan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LaplaceXD%2FPan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LaplaceXD%2FPan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LaplaceXD","download_url":"https://codeload.github.com/LaplaceXD/Pan/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248746926,"owners_count":21155350,"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":["css-module","express","formik-yup","javascript","json-as-xlsx","mysql2","nodejs","react-query","reactjs","redis","vite","xlsx"],"created_at":"2024-11-26T14:12:11.196Z","updated_at":"2025-04-13T16:41:00.428Z","avatar_url":"https://github.com/LaplaceXD.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pan\n\n![Last Update](https://img.shields.io/github/last-commit/LaplaceXD/Pan?color=blue\u0026label=Last%20Update)\n![Activity](https://img.shields.io/badge/Activity-Completed-blue)\n\n[Pan](https://pan-laplace.vercel.app/) is an inventory management system made for Pan. This system was made\nwith the use of [MySQL](https://www.mysql.com/), [React](https://beta.reactjs.org/),\n[Express](https://expressjs.com/), and [Node.js](https://nodejs.org/en/).\n\n## Functionalities\n- Generate reports, such as:\n  * `Inventory Report`, which contains the beginning and ending stocks, the number of goods sold, and the gross profit of each product within a month.\n  * `Sales Report` contains the top performing, least performing, and various statistics of the different products in the system.\n  * `Supplier Stock Report`, which contains the 'stock in' of the different suppliers within a month.\n  * `Employee Details Report`\n  * `Daily Sales Report`\n- Manage company resources such as employees, products, stocks, and suppliers.\n- Track, manage, and place orders based on the available products, and stocks in the system.\n- Filter data within the system.\n- Role-based authorization on different functionalities.\n- Authentication using [JWT tokens](https://jwt.io/).\n\n## Setup\n\n1. Clone this project to your local machine.\n2. Import `pan_db.sql` into your local MySQL database, and run your MySQL database.\n3. Create a Redis instance locally or through [Redis Labs](https://app.redislabs.com/).\n4. Create a [SendGrid](https://sendgrid.com/) account.\n5. Create `.env` files in the `client directory` and `server directory.`\n   \u003e The environment variables should contain the following:\n\n```\n# server/.env should contain the following variables\n\nSENDGRID_API_KEY  = \u003c\u003cyour sendgrid api key here\u003e\u003e\nREDIS_HOST        = \u003c\u003cyour redis host here\u003e\u003e\nREDIS_USERNAME    = \u003c\u003cyour redis user name\u003e\u003e\nREDIS_PASSWORD    = \u003c\u003cyour redis password\u003e\u003e\nREDIS_PORT        = \u003c\u003cyour redis port\u003e\u003e\n\n# client/.env should contain the following variables\n\nVITE_SERVER_URL   = http://localhost:3000/api/v1\n```\n\n6.  Run the following script in a terminal.\n\n```bash\ncd client\nnpm i\nnpm run dev\n\ncd ../server\nnpm i\nnpm run dev\n```\n\n7. You should be able to login through the login portal using the following credentials.\n\u003e Employee\n\n```\nemail: employee@pan.com\npassword: pan@employee123!\n```\n\u003e Manager\n\n```\nemail: manager@pan.com\npassword: pan@manager123!\n```\n\n8. ...\n9. Profit!\n\n## Contributing\n\nUnfortunately, we are not accepting pull requests, since this is a one-time project. However, feel free to\nfork this project, and improve on it!\n\n## Authors and Acknowledgement\n- [Jonh Alexis Buot](https://github.com/LaplaceXD) [Team Lead, Project Manager]\n- [Sherly Jao](https://github.com/jaosherlyr) [Web Designer, Front-End Developer]\n- [Nathan Arriesgado](https://github.com/n-e-t-a-n) [Back-End Developer]\n- [Erwin Antepuesto](https://github.com/cham0m1le) [Back-End Developer]\n\n## License\n\n[MIT](https://github.com/LaplaceXD/Pan/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaplacexd%2Fpan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flaplacexd%2Fpan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaplacexd%2Fpan/lists"}