https://github.com/developmenthf/medpantry-itproject-57
📦Custom built warehouse inventory management system for the Medical Pantry charity
https://github.com/developmenthf/medpantry-itproject-57
Last synced: about 1 year ago
JSON representation
📦Custom built warehouse inventory management system for the Medical Pantry charity
- Host: GitHub
- URL: https://github.com/developmenthf/medpantry-itproject-57
- Owner: DevelopmentHF
- Created: 2024-07-25T01:03:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-03T05:44:08.000Z (over 1 year ago)
- Last Synced: 2024-12-25T13:38:09.961Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://medpantry-itproject-57.vercel.app
- Size: 877 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# medpantry-itproject-57
## What is this?
[A set of simple solutions to better integrate Medical Pantry's warehouse and Shopify system](https://medpantry-itproject.atlassian.net/wiki/spaces/SD/overview?homepageId=295019)
--
## Folder Structure
``` bash
├── README.md
├── backend
│ └── WarehouseInterface
│ ├── HELP.md
│ ├── ...
│ ├── build.gradle
│ └── src
│ ├── main
│ ├── java
│ │ └── org
│ │ └── example
│ │ └── warehouseinterface
│ │ ├── WarehouseInterfaceApplication.java
│ │ ├── api
│ │ │ ├── controller // endpoints go here :)
│ │ │ │ └── BaxterBoxController.java
│ │ │ └── model // database models go here :)
│ │ │ └── BaxterBox.java
│ │ └── service // business logic goes here :)
│ │ └── BaxterBoxService.java
│ └── resources
│ ├── application.properties
│ ├── static
│ └── templates
└── test
└── java
└── org
└── example
└── warehouseinterface
└── WarehouseInterfaceApplicationTests.java
└── frontend
└── medpantry
├── README.md
├── app
├── components // our front end components get built here :)
├── AuthButton.tsx
├── DeployButton.tsx
├── Header.tsx
├── NextLogo.tsx
├── SupabaseLogo.tsx
├── card.tsx
├── sidebar.tsx
├── tutorial
│ ├── Code.tsx
│ ├── ConnectSupabaseSteps.tsx
│ ├── FetchDataSteps.tsx
│ ├── SignUpUserSteps.tsx
│ └── Step.tsx
└── ui
├── button.tsx
├── input.tsx
└── separator.tsx
├── components.json
├── lib
├── middleware.ts
├── next-env.d.ts
├── next.config.js
├── node_modules
├── package-lock.json
├── package.json
├── postcss.config.js
├── tailwind.config.ts
├── tsconfig.json
└── utils
```
---
## Running the project
### Frontend
To run the web-app component of this project, please connect the supabase variables to the `.env.local` file as outlined in the frontend/medpantry/README.md.
Also in `.env.local`, add the server backend link. The server, which hasn't been deployed yet, is hosted on `https://localhost:8080`.
Thus, the `.env.local` file should appear as so:
```
NEXT_PUBLIC_SUPABASE_URL=https://XXXXXX.supabase.co
NEXT_PUBLIC_SUPABASE_ANON_KEY=XXXXXX
NEXT_PUBLIC_BACKEND_LINK=http://localhost:8080
NEXT_PUBLIC_API_KEY=XXXX # this is set by the developer below
```
Once this has been filled out, naviagate to `frontend/medpantry/` then execute the following to start the dev server:
```npm run dev```
### Backend
To run the server which hosts the custom API, please create a `.env` file in `backend/WarehouseInterface/main/resources` and populate it with the same API keys as in *frontend/*.
Furthermore, you need to fill in the *Shopify* admin key extracted from the owners page. Thus the `.env` file should appear as so:
```
SUPABASE_URL=XXXXX.supabase.co
SUPABASE_API_KEY=XXXXX
SHOPIFY_ADMIN_KEY=XXXXX
API_KEY=henry #Choose a secure password to send in the headers
```
To test the API, please use the Postman service, and execute a command like so:
```
localhost:8080/baxterbox?id=2
```
... which fetches the baxter box number 2
---
Make sure the API_KEY you manually define like a password is reflected in the frontend!
## Contribution guidelines
Please follow the contribution guidelines, found [here](https://medpantry-itproject.atlassian.net/wiki/spaces/SD/pages/19267585/Development+Practices)
---
## Handover
For a full run down on how to get up and running, view the Product Handover page on the confluence