Compare commits
8 Commits
e4467dba32
...
v1.1
Author | SHA1 | Date | |
---|---|---|---|
7faf95188d | |||
79df00a17e | |||
d1625d7e47 | |||
a8377e5ec3 | |||
8f1d401aa1 | |||
226a267ccb | |||
fd9496645a | |||
33bb64f44b |
2
.gitignore
vendored
2
.gitignore
vendored
@@ -112,3 +112,5 @@ backend/public/uploads/
|
||||
config/
|
||||
secrets/
|
||||
keys/
|
||||
|
||||
ToDo.txt
|
11
Docs/HELP.md
Normal file
11
Docs/HELP.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Hilfe Seite
|
||||
|
||||
Hier finden Sie Informationen zur Verwendung des Systems.
|
||||
|
||||
## Unerwartete Probleme
|
||||
|
||||
Falls unerwartetet Probleme im Web oder im Safe auftreten sollten, können Sie den Support via Teams kontaktieren.
|
||||
|
||||
**Kontaktpersonen:**
|
||||
- Theis Gaedigk (Web & Safe)
|
||||
- Niklas Brunke (Safe)
|
@@ -8,7 +8,7 @@ On this page you will learn how my API works.
|
||||
|
||||
When you look at my backend folder and file structure, you can see that I have two files called `API`. The first file called `api.js` is for my web frontend, because this file works together with my JWT token service.
|
||||
|
||||
But I have built a second API. You can see the second API file in the same directory, the file is called `apiV2.js`.
|
||||
**\*But I have built a second API. You can see the second API file in the same directory, the file is called `apiV2.js`.**
|
||||
|
||||
This is the file that you can use to build an API.
|
||||
|
||||
@@ -45,21 +45,114 @@ Returns a list of all items and their details.
|
||||
#### Example Request
|
||||
|
||||
```
|
||||
GET /apiV2/items/your_admin_key
|
||||
GET https://backend.insta.the1s.de/apiV2/items/your_admin_key
|
||||
```
|
||||
|
||||
#### Example Response
|
||||
|
||||
```
|
||||
[
|
||||
{
|
||||
"id": 1,
|
||||
"item_name": "DJI 1er Mikro",
|
||||
"can_borrow_role": "4",
|
||||
"inSafe": 1
|
||||
},
|
||||
...
|
||||
]
|
||||
{
|
||||
"data": [
|
||||
{
|
||||
"id": 1,
|
||||
"item_name": "DJI 1er Mikro",
|
||||
"can_borrow_role": 4,
|
||||
"inSafe": 1,
|
||||
"entry_created_at": "2025-08-19T22:02:16.000Z"
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"item_name": "DJI 2er Mikro 1",
|
||||
"can_borrow_role": 4,
|
||||
"inSafe": 1,
|
||||
"entry_created_at": "2025-08-19T22:02:16.000Z"
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"item_name": "DJI 2er Mikro 2",
|
||||
"can_borrow_role": 4,
|
||||
"inSafe": 1,
|
||||
"entry_created_at": "2025-08-19T22:02:16.000Z"
|
||||
},
|
||||
{
|
||||
"id": 4,
|
||||
"item_name": "Rode Richt Mikrofon",
|
||||
"can_borrow_role": 2,
|
||||
"inSafe": 1,
|
||||
"entry_created_at": "2025-08-19T22:02:16.000Z"
|
||||
},
|
||||
{
|
||||
"id": 5,
|
||||
"item_name": "Kamera Stativ",
|
||||
"can_borrow_role": 1,
|
||||
"inSafe": 1,
|
||||
"entry_created_at": "2025-08-19T22:02:16.000Z"
|
||||
},
|
||||
{
|
||||
"id": 6,
|
||||
"item_name": "SONY Kamera - inkl. Akkus und Objektiv",
|
||||
"can_borrow_role": 1,
|
||||
"inSafe": 1,
|
||||
"entry_created_at": "2025-08-19T22:02:16.000Z"
|
||||
},
|
||||
{
|
||||
"id": 7,
|
||||
"item_name": "MacBook inkl. Adapter",
|
||||
"can_borrow_role": 2,
|
||||
"inSafe": 1,
|
||||
"entry_created_at": "2025-08-19T22:02:16.000Z"
|
||||
},
|
||||
{
|
||||
"id": 8,
|
||||
"item_name": "SD Karten",
|
||||
"can_borrow_role": 3,
|
||||
"inSafe": 1,
|
||||
"entry_created_at": "2025-08-19T22:02:16.000Z"
|
||||
},
|
||||
{
|
||||
"id": 9,
|
||||
"item_name": "Kameragimbal",
|
||||
"can_borrow_role": 1,
|
||||
"inSafe": 1,
|
||||
"entry_created_at": "2025-08-19T22:02:16.000Z"
|
||||
},
|
||||
{
|
||||
"id": 10,
|
||||
"item_name": "ATEM MINI PRO",
|
||||
"can_borrow_role": 1,
|
||||
"inSafe": 1,
|
||||
"entry_created_at": "2025-08-19T22:02:16.000Z"
|
||||
},
|
||||
{
|
||||
"id": 11,
|
||||
"item_name": "Handygimbal",
|
||||
"can_borrow_role": 4,
|
||||
"inSafe": 1,
|
||||
"entry_created_at": "2025-08-19T22:02:16.000Z"
|
||||
},
|
||||
{
|
||||
"id": 12,
|
||||
"item_name": "Kameralfter",
|
||||
"can_borrow_role": 1,
|
||||
"inSafe": 1,
|
||||
"entry_created_at": "2025-08-19T22:02:16.000Z"
|
||||
},
|
||||
{
|
||||
"id": 13,
|
||||
"item_name": "Kleine Kamera 1 - inkl. Objektiv",
|
||||
"can_borrow_role": 2,
|
||||
"inSafe": 1,
|
||||
"entry_created_at": "2025-08-19T22:02:16.000Z"
|
||||
},
|
||||
{
|
||||
"id": 14,
|
||||
"item_name": "Kleine Kamera 2 - inkl. Objektiv",
|
||||
"can_borrow_role": 2,
|
||||
"inSafe": 1,
|
||||
"entry_created_at": "2025-08-19T22:02:16.000Z"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Each item has the following properties:
|
||||
@@ -69,6 +162,8 @@ Each item has the following properties:
|
||||
- `can_borrow_role`: The role ID that is allowed to borrow the item.
|
||||
- `inSafe`: Indicates whether the item is currently in the locker (1) or not (0). This variable/state can change over time.
|
||||
|
||||
_You also get an http 200 status code._
|
||||
|
||||
---
|
||||
|
||||
### 2. Change Item Safe State
|
||||
@@ -82,7 +177,7 @@ Updates the `inSafe` state of an item (whether it is in the locker).
|
||||
#### Example Request
|
||||
|
||||
```
|
||||
POST /apiV2/controlInSafe/your_admin_key/5/0
|
||||
POST https://backend.insta.the1s.de/apiV2/controlInSafe/your_admin_key/item_id/new_item_state
|
||||
```
|
||||
|
||||
#### Example Response
|
||||
@@ -93,7 +188,7 @@ POST /apiV2/controlInSafe/your_admin_key/5/0
|
||||
|
||||
_An empty object means, that the operation was successful and no further information is returned._
|
||||
|
||||
_You also get an http 2xx status code._
|
||||
_You also get an http 200 status code._
|
||||
|
||||
---
|
||||
|
||||
@@ -108,7 +203,7 @@ Sets the `returned_date` of a loan to the current server time.
|
||||
#### Example Request
|
||||
|
||||
```
|
||||
POST /apiV2/setReturnDate/your_admin_key/123456
|
||||
POST https://backend.insta.the1s.de/apiV2/setReturnDate/your_admin_key/your_loan_code
|
||||
```
|
||||
|
||||
#### Example Response
|
||||
@@ -119,7 +214,7 @@ POST /apiV2/setReturnDate/your_admin_key/123456
|
||||
|
||||
_An empty object means, that the operation was successful and no further information is returned._
|
||||
|
||||
_You also get an http 2xx status code._
|
||||
_You also get an http 200 status code._
|
||||
|
||||
---
|
||||
|
||||
@@ -134,7 +229,7 @@ Sets the `take_date` of a loan to the current server time.
|
||||
#### Example Request
|
||||
|
||||
```
|
||||
POST /apiV2/setTakeDate/your_admin_key/123456
|
||||
POST https://backend.insta.the1s.de/apiV2/setTakeDate/your_admin_key/your_loan_code
|
||||
```
|
||||
|
||||
#### Example Response
|
||||
@@ -149,6 +244,57 @@ _You also get an http 2xx status code._
|
||||
|
||||
---
|
||||
|
||||
### 5. Get whole loan by loan code
|
||||
|
||||
**POST** `/getLoanByCode/:key/:loan_code`
|
||||
|
||||
Retrieves the details of a specific loan by its unique code.
|
||||
|
||||
- `loan_code`: The unique code of the loan.
|
||||
|
||||
#### Example Request
|
||||
|
||||
```
|
||||
GET https://backend.insta.the1s.de/getLoanByCode/your_admin_key/your_loan_code
|
||||
```
|
||||
|
||||
#### Example Response
|
||||
|
||||
```
|
||||
{
|
||||
"data": {
|
||||
"id": 6,
|
||||
"username": "theis",
|
||||
"loan_code": 646473,
|
||||
"start_date": "2025-08-25T13:23:00.000Z",
|
||||
"end_date": "2025-08-26T13:23:00.000Z",
|
||||
"take_date": null,
|
||||
"returned_date": null,
|
||||
"created_at": "2025-08-20T11:23:40.000Z",
|
||||
"loaned_items_id": [
|
||||
8,
|
||||
9
|
||||
],
|
||||
"loaned_items_name": [
|
||||
"SD Karten",
|
||||
"Kameragimbal"
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
_You also get an http 200 status code._
|
||||
|
||||
If the loan id does not exist, you will receive a 404 status code and an error message.
|
||||
|
||||
```
|
||||
{
|
||||
"message": "Loan not found"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Error Handling
|
||||
|
||||
- `403 Forbidden`: Invalid or missing API key.
|
||||
|
12
frontend/src/components/Footer.tsx
Normal file
12
frontend/src/components/Footer.tsx
Normal file
@@ -0,0 +1,12 @@
|
||||
import React from "react";
|
||||
|
||||
const Footer: React.FC = () => {
|
||||
return (
|
||||
<footer className="fixed bottom-0 left-0 text-sm w-full bg-slate-100 text-center py-2 border-t border-slate-200 z-50">
|
||||
<p>Made with ❤️ by Theis Gaedigk - Jahrgang 2019</p>
|
||||
<p>v1.1</p>
|
||||
</footer>
|
||||
);
|
||||
};
|
||||
|
||||
export default Footer;
|
@@ -23,6 +23,16 @@ const Header: React.FC<HeaderProps> = ({ onLogout }) => {
|
||||
>
|
||||
Logout
|
||||
</button>
|
||||
<a href="https://git.the1s.de/Matthias-Claudius-Schule/borrow-system/src/branch/dev/Docs/HELP.md">
|
||||
<button className="h-9 px-3 rounded-md border border-slate-300 text-slate-700 hover:bg-slate-100 transition">
|
||||
Hilfe
|
||||
</button>
|
||||
</a>
|
||||
<a href="https://git.the1s.de/Matthias-Claudius-Schule/borrow-system">
|
||||
<button className="h-9 px-3 rounded-md border border-slate-300 text-slate-700 hover:bg-slate-100 transition">
|
||||
Source Code
|
||||
</button>
|
||||
</a>
|
||||
</div>
|
||||
</header>
|
||||
);
|
||||
|
@@ -1,4 +1,5 @@
|
||||
import React from "react";
|
||||
import Footer from "./Footer";
|
||||
import { useState } from "react";
|
||||
import { loginUser } from "../utils/fetchData";
|
||||
import { myToast } from "../utils/toastify";
|
||||
@@ -66,6 +67,7 @@ const LoginForm: React.FC<LoginFormProps> = ({ onLogin }) => {
|
||||
</button>
|
||||
</form>
|
||||
</div>
|
||||
<Footer />
|
||||
</div>
|
||||
);
|
||||
};
|
||||
|
@@ -70,7 +70,9 @@ const Sidebar: React.FC = () => {
|
||||
<Object
|
||||
title={item.item_name}
|
||||
description={
|
||||
item.inSafe ? "Im Schließfach" : "Nicht im Schließfach"
|
||||
item.inSafe
|
||||
? "Aktuell im Schließfach"
|
||||
: "Aktuell nicht im Schließfach"
|
||||
}
|
||||
/>
|
||||
</div>
|
||||
@@ -81,7 +83,7 @@ const Sidebar: React.FC = () => {
|
||||
<div className="mt-4 pt-3 border-t border-slate-200/70 text-[10px] sm:text-xs text-slate-500 items-center gap-4 hidden md:flex">
|
||||
<span className="inline-flex items-center gap-1">
|
||||
<span className="inline-block w-3 h-3 bg-emerald-500 rounded-full ring-2 ring-white shadow-sm"></span>
|
||||
Verfügbar
|
||||
Im Schließfach
|
||||
</span>
|
||||
<span className="inline-flex items-center gap-1">
|
||||
<span className="inline-block w-3 h-3 bg-red-500 rounded-full ring-2 ring-white shadow-sm"></span>
|
||||
|
@@ -2,6 +2,7 @@ import React from "react";
|
||||
import "../App.css";
|
||||
import Header from "../components/Header";
|
||||
import Sidebar from "../components/Sidebar";
|
||||
import Footer from "../components/Footer";
|
||||
|
||||
type LayoutProps = {
|
||||
children: React.ReactNode;
|
||||
@@ -10,15 +11,13 @@ type LayoutProps = {
|
||||
|
||||
const Layout: React.FC<LayoutProps> = ({ children, onLogout }) => {
|
||||
return (
|
||||
<div className="h-screen overflow-hidden flex bg-slate-50 text-slate-800">
|
||||
<div className="h-screen flex flex-col bg-slate-50 text-slate-800">
|
||||
{/* Main */}
|
||||
<main className="flex-1 min-h-0 overflow-hidden flex flex-col items-center px-3 sm:px-5 py-4 sm:py-8">
|
||||
{/* Sidebar on mobile appears inline on top; on desktop it's a sticky column */}
|
||||
<main className="flex-1 min-h-0 overflow-hidden flex flex-col items-center px-3 sm:px-5 py-4 sm:py-8 pb-12">
|
||||
<div className="w-full max-w-5xl flex flex-col gap-3 md:flex-row md:gap-6 md:items-stretch min-h-0 h-full">
|
||||
<div className="hidden md:flex md:flex-col md:shrink-0 md:w-72 md:min-h-0 md:h-full">
|
||||
<Sidebar />
|
||||
</div>
|
||||
|
||||
<div className="flex-1 min-w-0 min-h-0 h-full flex flex-col overflow-hidden">
|
||||
<div className="w-full">
|
||||
<Header onLogout={onLogout} />
|
||||
@@ -29,6 +28,7 @@ const Layout: React.FC<LayoutProps> = ({ children, onLogout }) => {
|
||||
</div>
|
||||
</div>
|
||||
</main>
|
||||
<Footer />
|
||||
</div>
|
||||
);
|
||||
};
|
||||
|
Reference in New Issue
Block a user