readme

Read me.md

@@ -1,64 +0,0 @@
-### Spelling Game ###
-
----
-
-### 🐳 **How to Clone and Run the Spelling App from Gitea with Docker Compose**
-
-1. **Install Docker & Docker Compose**
-   - Mac: [Docker Desktop for Mac](https://www.docker.com/products/docker-desktop/)
-   - Windows: [Docker Desktop for Windows](https://www.docker.com/products/docker-desktop/)
-   - Linux: Use your package manager (e.g. `apt install docker docker-compose`)
-
-2. **Clone the Repository**
-
-```bash
-git clone https://git.necloud.us/nmemmert/Spelling.git
-cd Spelling
-```
-
-3. **Build & Start the Container**
-
-```bash
-docker-compose up --build
-```
-
-This will:
-- Build the Docker image using the included `Dockerfile`
-- Start the container on port 3000
-- Mount your user data (like `users.json` and `wordlists.json`) so they persist
-
-4. **Access the App**
-
-Open your browser and visit:
-
-```
-http://localhost:3000
-```
-
-🎉 You’re in! Log in with a predefined user from `users.json` (e.g., `admin1` / `password`).
-
-5. **Stop the App**
-
-To shut it down when you're done:
-
-```bash
-docker-compose down
-```
-
----
-
-### ✅ Optional: Run in the Background
-
-```bash
-docker-compose up -d
-```
-
-To stop it later:
-
-```bash
-docker-compose down
-```
-
----
-
-Want me to generate a `README.md` from this? Or help automate updates with a webhook from your Gitea server? You’re primed for self-hosted greatness.

Readme.md

@@ -0,0 +1,45 @@
+# 📝 Spelling App
+
+A lightweight, multi-user spelling practice app with admin controls, customizable themes, and per-user word list management. Built with Node.js, Express, and Docker.
+
+---
+
+## 🚀 Quick Start (Docker Compose)
+
+Clone and run from anywhere using Docker Compose:
+
+```bash
+git clone https://git.necloud.us/nmemmert/Spelling.git
+cd Spelling
+docker-compose up --build
+
+👥 Default Login
+Username	Password	Role
+admin1	password	Admin
+student1	123456	Student
+You can add new users from the Admin Panel.
+
+⚙️ Features
+🔐 Login system with admin and student roles
+
+🌈 Theme switching (Playground, Chalkboard, Galaxy, Nature)
+
+📚 Student-specific word list storage (on server!)
+
+📤 Upload word lists or enter manually
+
+🎮 Spelling game with instant feedback and retry mode
+
+🧑‍🏫 Admin tools to manage users and word lists
+
+🐳 Fully containerized via Docker Compose
+
+🐳 Docker Commands
+Run in background:
+
+bash
+docker-compose up -d
+Stop the app:
+
+bash
+docker-compose down