diff --git a/Readme.md b/Readme.md index cca834b..fd1323a 100644 --- a/Readme.md +++ b/Readme.md @@ -1,6 +1,6 @@ # 📝 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. +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**. --- @@ -12,34 +12,23 @@ Clone and run from anywhere using Docker Compose: git clone https://git.necloud.us/nmemmert/Spelling.git cd Spelling docker-compose up --build +Then visit: 👉 http://localhost:3000 -👥 Default Login -Username Password Role -admin1 password Admin -student1 123456 Student -You can add new users from the Admin Panel. +## 👥 Default Login -⚙️ Features -🔐 Login system with admin and student roles +| Username | Password | Role | +|-----------|----------|--------| +| admin1 | password | Admin | +| student1 | 123456 | Student| -🌈 Theme switching (Playground, Chalkboard, Galaxy, Nature) +> You can add new users from the Admin Panel. -📚 Student-specific word list storage (on server!) +## ⚙️ Features -📤 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 \ No newline at end of file +- 🔐 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**