Updated README

This commit is contained in:
Sean Edmunds
2025-01-17 11:49:51 -06:00
parent ebc003593f
commit 0ca9110379
3 changed files with 1254 additions and 1334 deletions

View File

@@ -1,6 +1,26 @@
# Setup
Install MariaDB/MySQL
Install Git
Install Node 19+
npm install --legacy-peer-deps
To run:
npm run dev
To build:
Add any background images to public/backgrounds to include them in the build
npm run build
Run with pm2:
npm install -g pm2
sudo pm2 serve ./dist --no-daemon --spa --port 3000
# TODO # TODO
- Image uploads for backgrounds - Image uploads for backgrounds
- Create actions section - Create actions section
- Improve mobile - Improve mobile

2498
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -10,47 +10,47 @@
"preview": "vite preview" "preview": "vite preview"
}, },
"dependencies": { "dependencies": {
"@emotion/react": "^11.13.0", "@emotion/react": "^11.14.0",
"@iconify/react": "^5.0.2", "@iconify/react": "^5.2.0",
"@mantine/core": "^7.12.1", "@mantine/core": "^7.16.0",
"@mantine/dates": "^7.12.1", "@mantine/dates": "^7.16.0",
"@mantine/form": "^7.12.1", "@mantine/form": "^7.16.0",
"@mantine/hooks": "^7.12.1", "@mantine/hooks": "^7.16.0",
"@mantine/modals": "^7.12.1", "@mantine/modals": "^7.16.0",
"@tabler/icons-react": "^3.12.0", "@tabler/icons-react": "^3.28.1",
"@tanstack/react-query": "^5.51.23", "@tanstack/react-query": "^5.64.1",
"@tanstack/react-query-devtools": "^5.0.0-alpha.91", "@tanstack/react-query-devtools": "^5.64.1",
"@tanstack/react-query-persist-client": "^5.51.23", "@tanstack/react-query-persist-client": "^5.64.1",
"clsx": "^2.1.1", "clsx": "^2.1.1",
"dayjs": "^1.11.12", "dayjs": "^1.11.13",
"dotenv": "^16.4.7", "dotenv": "^16.4.7",
"idb-keyval": "^6.2.1", "idb-keyval": "^6.2.1",
"jotai": "^2.9.3", "jotai": "^2.11.0",
"mantine-react-table": "^2.0.0-beta.6", "mantine-react-table": "^2.0.0-beta.6",
"react": "^18.3.1", "react": "^19.0.0",
"react-dom": "^18.3.1", "react-dom": "^19.0.0",
"react-icons": "^5.3.0", "react-icons": "^5.4.0",
"react-query": "^3.39.3", "react-query": "^3.39.3",
"react-router-dom": "^6.26.0", "react-router-dom": "^7.1.2",
"react-toastify": "^10.0.5" "react-toastify": "^11.0.3"
}, },
"devDependencies": { "devDependencies": {
"@types/node": "^22.10.1", "@types/node": "^22.10.7",
"@types/react": "^18.3.3", "@types/react": "^19.0.7",
"@types/react-dom": "^18.3.0", "@types/react-dom": "^19.0.3",
"@typescript-eslint/eslint-plugin": "^8.1.0", "@typescript-eslint/eslint-plugin": "^8.20.0",
"@typescript-eslint/parser": "^8.1.0", "@typescript-eslint/parser": "^8.20.0",
"@vitejs/plugin-react": "^4.3.1", "@vitejs/plugin-react": "^4.3.4",
"eslint": "^9.9.0", "eslint": "^9.18.0",
"eslint-plugin-react-hooks": "^4.6.2", "eslint-plugin-react-hooks": "^5.1.0",
"eslint-plugin-react-refresh": "^0.4.9", "eslint-plugin-react-refresh": "^0.4.18",
"typescript": "^5.5.4", "typescript": "^5.7.3",
"vite": "^5.4.0", "vite": "^6.0.7",
"vite-plugin-dts": "~4.0.1", "vite-plugin-dts": "~4.5.0",
"vite-plugin-eslint": "^1.8.1", "vite-plugin-eslint": "^1.8.1",
"vite-tsconfig-paths": "^4.3.2", "vite-tsconfig-paths": "^5.1.4",
"vitest": "^2.0.5", "vitest": "^3.0.2",
"@vitest/coverage-v8": "^2.0.5", "@vitest/coverage-v8": "^3.0.2",
"@vitest/ui": "^2.0.5" "@vitest/ui": "^3.0.2"
} }
} }