diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..f968fcf --- /dev/null +++ b/.env.example @@ -0,0 +1 @@ +SERVER_ADDRESS = serveradress diff --git a/.gitignore b/.gitignore index e1f930a..9a2b281 100644 --- a/.gitignore +++ b/.gitignore @@ -38,4 +38,6 @@ coverage *.sln *.sw? -*.tsbuildinfo \ No newline at end of file +*.tsbuildinfo + +.env \ No newline at end of file diff --git a/README.md b/README.md index 51b4921..96de736 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ # member-administration-ui -Mitgliederverwaltung \ No newline at end of file +Memberadministration + +## Installation + +### Requirements + +1. Access to the internet + +### Configuration + +1. Copy the .env.example file to .env and fill in the required information +2. Install all packages via `npm install` +3. Start the backend application +4. Start the application +5. Run `npm run dev` to run inside dev-environment + +### Usage + +1. Open the browser and navigate to `http://localhost:5173` or the URL you specified in the server configuration +2. Go to route `/setup` to create the first user (this path is disabled after the first user is created) diff --git a/src/App.vue b/src/App.vue index bd8a4af..587c449 100644 --- a/src/App.vue +++ b/src/App.vue @@ -1,4 +1,7 @@