Compare commits
5 Commits
36ad60b782
...
debian12_v
Author | SHA1 | Date | |
---|---|---|---|
1b15cf96e8 | |||
bb7f66ecc7 | |||
59de6d69d9 | |||
478f03452d | |||
a932144e94 |
72
README.md
72
README.md
@@ -1,73 +1,7 @@
|
||||
# Borrow System
|
||||
|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||
**You have reached the `debian12` branch.**
|
||||
|
||||
A small full‑stack system to log in, view available items, reserve them for a time window, and manage personal loans.
|
||||
Here you will find the source code of exactly the application that I have hosted.
|
||||
|
||||
- Frontend: React + TypeScript + Vite + Tailwind CSS
|
||||
- Backend: Node.js + Express + MySQL + JWT (jose)
|
||||
- Orchestration: Docker Compose (backend + MySQL)
|
||||
|
||||
## Contents
|
||||
|
||||
- Frontend: [frontend/](frontend)
|
||||
- Vite/Tailwind config: [frontend/vite.config.ts](frontend/vite.config.ts), [frontend/tailwind.config.js](frontend/tailwind.config.js)
|
||||
- App entry: [frontend/src/main.tsx](frontend/src/main.tsx), [frontend/src/App.tsx](frontend/src/App.tsx)
|
||||
- UI: [frontend/src/layout/Layout.tsx](frontend/src/layout/Layout.tsx), [frontend/src/components](frontend/src/components)
|
||||
- Data/utilities: [frontend/src/utils/fetchData.ts](frontend/src/utils/fetchData.ts), [frontend/src/utils/userHandler.ts](frontend/src/utils/userHandler.ts), [frontend/src/utils/toastify.ts](frontend/src/utils/toastify.ts)
|
||||
- Backend: [backend/](backend)
|
||||
- Server: [backend/server.js](backend/server.js)
|
||||
- Routes: [backend/routes/api.js](backend/routes/api.js), [backend/routes/apiV2.js](backend/routes/apiV2.js)
|
||||
- DB + services: [backend/services/database.js](backend/services/database.js), [backend/services/tokenService.js](backend/services/tokenService.js)
|
||||
- Schema/seed: [backend/scheme.sql](backend/scheme.sql)
|
||||
- Docs: [docs/](docs)
|
||||
- API docs (see below): [docs/backend_API_docs/README.md](docs/backend_API_docs/README.md)
|
||||
|
||||
## Features (high‑level)
|
||||
|
||||
- Auth via JWT (login -> token cookie) using the backend route in [backend/routes/api.js](backend/routes/api.js).
|
||||
- After login, the app loads items, loans, and user loans and keeps them in localStorage.
|
||||
- Choose a date range to fetch borrowable items, select items, and create a loan.
|
||||
- Manage personal loans list (and delete a loan).
|
||||
|
||||
Key frontend utilities:
|
||||
|
||||
- [`utils.fetchData.fetchAllData`](frontend/src/utils/fetchData.ts): loads items, loans, and user loans after login.
|
||||
- [`utils.fetchData.getBorrowableItems`](frontend/src/utils/fetchData.ts): fetches borrowable items for the selected time range.
|
||||
- [`utils.userHandler.createLoan`](frontend/src/utils/userHandler.ts): creates a new loan for selected items.
|
||||
- [`utils.userHandler.handleDeleteLoan`](frontend/src/utils/userHandler.ts): deletes a loan and syncs local state.
|
||||
- [`utils.toastify.myToast`](frontend/src/utils/toastify.ts): toast notifications.
|
||||
|
||||
UI flow (main screens):
|
||||
|
||||
- Period selection: [frontend/src/components/Form1.tsx](frontend/src/components/Form1.tsx)
|
||||
- Borrowable items + selection: [frontend/src/components/Form2.tsx](frontend/src/components/Form2.tsx)
|
||||
- User loans table: [frontend/src/components/Form4.tsx](frontend/src/components/Form4.tsx)
|
||||
|
||||
## Development
|
||||
|
||||
- Scripts: see [frontend/package.json](frontend/package.json) and [backend/package.json](backend/package.json)
|
||||
- Frontend: `npm run dev`, `npm run build`, `npm run preview`, `npm run lint`
|
||||
- Backend: `npm start`
|
||||
- Linting: ESLint configured via [frontend/eslint.config.js](frontend/eslint.config.js)
|
||||
- TypeScript configs: [frontend/tsconfig.app.json](frontend/tsconfig.app.json), [frontend/tsconfig.node.json](frontend/tsconfig.node.json)
|
||||
|
||||
## Configuration notes
|
||||
|
||||
- Vite/Tailwind integration via [frontend/vite.config.ts](frontend/vite.config.ts) and `@tailwindcss/vite`; CSS entry uses `@import "tailwindcss"` in [frontend/src/index.css](frontend/src/index.css).
|
||||
- Toasts wired in [frontend/src/main.tsx](frontend/src/main.tsx) with `react-toastify`.
|
||||
- Local state is stored in `localStorage` keys: `allItems`, `allLoans`, `userLoans`, `borrowableItems`. Cross‑component updates are signaled via window events from [`utils.fetchData`](frontend/src/utils/fetchData.ts).
|
||||
|
||||
## API documentation
|
||||
|
||||
Refer to the dedicated API docs:
|
||||
|
||||
`docs/backend_API_docs/README.md`
|
||||
The main branch or the branch that I am developing on, is the `dev` branch.
|
@@ -7,6 +7,8 @@ import {
|
||||
deleteLoanFromDatabase,
|
||||
getBorrowableItemsFromDatabase,
|
||||
createLoanInDatabase,
|
||||
onTake,
|
||||
onReturn,
|
||||
} from "../services/database.js";
|
||||
import { authenticate, generateToken } from "../services/tokenService.js";
|
||||
const router = express.Router();
|
||||
@@ -85,6 +87,26 @@ router.post("/borrowableItems", authenticate, async (req, res) => {
|
||||
}
|
||||
});
|
||||
|
||||
router.post("/takeLoan/:id", authenticate, async (req, res) => {
|
||||
const loanId = req.params.id;
|
||||
const result = await onTake(loanId);
|
||||
if (result.success) {
|
||||
res.status(200).json({ message: "Loan taken successfully" });
|
||||
} else {
|
||||
res.status(500).json({ message: "Failed to take loan" });
|
||||
}
|
||||
});
|
||||
|
||||
router.post("/returnLoan/:id", authenticate, async (req, res) => {
|
||||
const loanId = req.params.id;
|
||||
const result = await onReturn(loanId);
|
||||
if (result.success) {
|
||||
res.status(200).json({ message: "Loan returned successfully" });
|
||||
} else {
|
||||
res.status(500).json({ message: "Failed to return loan" });
|
||||
}
|
||||
});
|
||||
|
||||
router.post("/createLoan", authenticate, async (req, res) => {
|
||||
try {
|
||||
const { items, startDate, endDate } = req.body || {};
|
||||
|
@@ -294,3 +294,29 @@ export const createLoanInDatabase = async (
|
||||
conn.release();
|
||||
}
|
||||
};
|
||||
|
||||
// These functions are only temporary, and will be deleted when the full bin is set up.
|
||||
|
||||
export const onTake = async (loanId) => {
|
||||
const [result] = await pool.query(
|
||||
"UPDATE loans SET take_date = NOW() WHERE id = ?",
|
||||
[loanId]
|
||||
);
|
||||
|
||||
if (result.affectedRows > 0) {
|
||||
return { success: true };
|
||||
}
|
||||
return { success: false };
|
||||
};
|
||||
|
||||
export const onReturn = async (loanId) => {
|
||||
const [result] = await pool.query(
|
||||
"UPDATE loans SET returned_date = NOW() WHERE id = ?",
|
||||
[loanId]
|
||||
);
|
||||
|
||||
if (result.affectedRows > 0) {
|
||||
return { success: true };
|
||||
}
|
||||
return { success: false };
|
||||
};
|
||||
|
@@ -4,6 +4,7 @@ import { handleDeleteLoan } from "../utils/userHandler";
|
||||
import { useMutation, useQuery } from "@tanstack/react-query";
|
||||
import Cookies from "js-cookie";
|
||||
import { queryClient } from "../utils/queryClient";
|
||||
import { onTake, onReturn } from "../utils/userHandler";
|
||||
|
||||
type Loan = {
|
||||
id: number;
|
||||
@@ -49,6 +50,20 @@ const Form4: React.FC = () => {
|
||||
},
|
||||
});
|
||||
|
||||
const takeMutation = useMutation({
|
||||
mutationFn: (loanID: number) => onTake(loanID),
|
||||
onSuccess: () => {
|
||||
queryClient.invalidateQueries({ queryKey: ["userLoans"] });
|
||||
},
|
||||
});
|
||||
|
||||
const returnMutation = useMutation({
|
||||
mutationFn: (loanID: number) => onReturn(loanID),
|
||||
onSuccess: () => {
|
||||
queryClient.invalidateQueries({ queryKey: ["userLoans"] });
|
||||
},
|
||||
});
|
||||
|
||||
const onDelete = (loanID: number) => deleteMutation.mutate(loanID);
|
||||
|
||||
if (isFetching) {
|
||||
@@ -99,11 +114,32 @@ const Form4: React.FC = () => {
|
||||
</div>
|
||||
<div>
|
||||
<span className="text-slate-500">Abgeholt:</span>{" "}
|
||||
{formatDate(loan.take_date)}
|
||||
{loan.take_date ? (
|
||||
formatDate(loan.take_date)
|
||||
) : (
|
||||
<button
|
||||
className="inline-flex items-center rounded-md border border-blue-200 bg-blue-50 px-2 py-0.5 text-[11px] font-medium text-blue-700 hover:bg-blue-100 focus:outline-none focus:ring-2 focus:ring-blue-500/40 disabled:opacity-50"
|
||||
onClick={() => takeMutation.mutate(loan.id)}
|
||||
disabled={takeMutation.isPending}
|
||||
>
|
||||
{takeMutation.isPending ? "..." : "Abholen"}
|
||||
</button>
|
||||
)}
|
||||
</div>
|
||||
<div>
|
||||
<span className="text-slate-500">Zurück:</span>{" "}
|
||||
{formatDate(loan.returned_date)}
|
||||
{loan.returned_date ? (
|
||||
formatDate(loan.returned_date)
|
||||
) : (
|
||||
<button
|
||||
className="inline-flex items-center rounded-md border border-emerald-200 bg-emerald-50 px-2 py-0.5 text-[11px] font-medium text-emerald-700 hover:bg-emerald-100 focus:outline-none focus:ring-2 focus:ring-emerald-500/40 disabled:opacity-50"
|
||||
onClick={() => returnMutation.mutate(loan.id)}
|
||||
disabled={returnMutation.isPending || !loan.take_date}
|
||||
title={!loan.take_date ? "Erst abholen" : ""}
|
||||
>
|
||||
{returnMutation.isPending ? "..." : "Zurückgeben"}
|
||||
</button>
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
<div className="mt-2 text-xs text-slate-700">
|
||||
@@ -170,10 +206,31 @@ const Form4: React.FC = () => {
|
||||
{formatDate(loan.end_date)}
|
||||
</td>
|
||||
<td className="px-4 py-3 whitespace-nowrap font-mono tabular-nums text-slate-900">
|
||||
{formatDate(loan.take_date)}
|
||||
{loan.take_date ? (
|
||||
formatDate(loan.take_date)
|
||||
) : (
|
||||
<button
|
||||
className="inline-flex items-center rounded-md border border-blue-200 bg-blue-50 px-2 py-1 text-xs font-medium text-blue-700 hover:bg-blue-100 focus:outline-none focus:ring-2 focus:ring-blue-500/40 disabled:opacity-50"
|
||||
onClick={() => takeMutation.mutate(loan.id)}
|
||||
disabled={takeMutation.isPending}
|
||||
>
|
||||
{takeMutation.isPending ? "..." : "Abholen"}
|
||||
</button>
|
||||
)}
|
||||
</td>
|
||||
<td className="px-4 py-3 whitespace-nowrap font-mono tabular-nums text-slate-900">
|
||||
{formatDate(loan.returned_date)}
|
||||
{loan.returned_date ? (
|
||||
formatDate(loan.returned_date)
|
||||
) : (
|
||||
<button
|
||||
className="inline-flex items-center rounded-md border border-emerald-200 bg-emerald-50 px-2 py-1 text-xs font-medium text-emerald-700 hover:bg-emerald-100 focus:outline-none focus:ring-2 focus:ring-emerald-500/40 disabled:opacity-50"
|
||||
onClick={() => returnMutation.mutate(loan.id)}
|
||||
disabled={returnMutation.isPending || !loan.take_date}
|
||||
title={!loan.take_date ? "Erst abholen" : ""}
|
||||
>
|
||||
{returnMutation.isPending ? "..." : "Zurückgeben"}
|
||||
</button>
|
||||
)}
|
||||
</td>
|
||||
<td className="px-4 py-3 whitespace-nowrap font-mono tabular-nums text-slate-900">
|
||||
{formatDate(loan.created_at)}
|
||||
@@ -182,7 +239,7 @@ const Form4: React.FC = () => {
|
||||
<div className="text-slate-900">
|
||||
{Array.isArray(loan.loaned_items_name)
|
||||
? loan.loaned_items_name.join(", ")
|
||||
: "-"}
|
||||
: ""}
|
||||
</div>
|
||||
</td>
|
||||
<td className="px-4 py-3 text-right">
|
||||
|
@@ -75,14 +75,17 @@ export const rmFromRemove = (itemID: number) => {
|
||||
|
||||
export const createLoan = async (startDate: string, endDate: string) => {
|
||||
const items = removeArr;
|
||||
const response = await fetch("https://backend.insta.the1s.de/api/createLoan", {
|
||||
const response = await fetch(
|
||||
"https://backend.insta.the1s.de/api/createLoan",
|
||||
{
|
||||
method: "POST",
|
||||
headers: {
|
||||
"Content-Type": "application/json",
|
||||
Authorization: `Bearer ${Cookies.get("token") || ""}`,
|
||||
},
|
||||
body: JSON.stringify({ items, startDate, endDate }),
|
||||
});
|
||||
}
|
||||
);
|
||||
|
||||
if (!response.ok) {
|
||||
myToast("Fehler beim Erstellen der Ausleihe", "error");
|
||||
@@ -100,3 +103,43 @@ export const createLoan = async (startDate: string, endDate: string) => {
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
export const onReturn = async (loanID: number) => {
|
||||
const response = await fetch(
|
||||
`https://backend.insta.the1s.de/api/returnLoan/${loanID}`,
|
||||
{
|
||||
method: "POST",
|
||||
headers: {
|
||||
Authorization: `Bearer ${Cookies.get("token") || ""}`,
|
||||
},
|
||||
}
|
||||
);
|
||||
|
||||
if (!response.ok) {
|
||||
myToast("Fehler beim Zurückgeben der Ausleihe", "error");
|
||||
return false;
|
||||
}
|
||||
|
||||
myToast("Ausleihe erfolgreich zurückgegeben!", "success");
|
||||
return true;
|
||||
};
|
||||
|
||||
export const onTake = async (loanID: number) => {
|
||||
const response = await fetch(
|
||||
`https://backend.insta.the1s.de/api/takeLoan/${loanID}`,
|
||||
{
|
||||
method: "POST",
|
||||
headers: {
|
||||
Authorization: `Bearer ${Cookies.get("token") || ""}`,
|
||||
},
|
||||
}
|
||||
);
|
||||
|
||||
if (!response.ok) {
|
||||
myToast("Fehler beim Ausleihen der Ausleihe", "error");
|
||||
return false;
|
||||
}
|
||||
|
||||
myToast("Ausleihe erfolgreich ausgeliehen!", "success");
|
||||
return true;
|
||||
};
|
||||
|
Reference in New Issue
Block a user