|
11 | 11 |
|
12 | 12 | **A professional, open-source content management system designed for creating beautiful tutorial websites with zero hassle.** |
13 | 13 |
|
14 | | -[Features](#-features) • [Quick Start](#-quick-start) • [Customization](#-customization) • [Documentation](#-documentation) • [License](#-license) |
| 14 | +[Project Purpose](#-project-purpose) • [Features](#-features) • [Quick Start](#-quick-start) • [Customization](#-customization) • [Documentation](#-documentation) • [License](#-license) |
15 | 15 |
|
16 | 16 | </div> |
17 | 17 |
|
18 | 18 | --- |
19 | 19 |
|
| 20 | +## 🎯 Project Purpose |
| 21 | + |
| 22 | +The Linux Tutorial CMS is a modern, open-source platform designed for creating and managing high-quality, interactive tutorial websites. It combines a high-performance Rust backend with a flexible React frontend to provide a seamless experience for both content creators and learners. The primary goal of this project is to offer a fully customizable, easy-to-use solution for educational content that is both beautiful and fast. |
| 23 | + |
20 | 24 | ## ✨ Features |
21 | 25 |
|
22 | 26 | ### 🎨 Beautiful Default Design |
@@ -89,15 +93,23 @@ npm run dev |
89 | 93 |
|
90 | 94 | ### Admin-Anmeldung |
91 | 95 |
|
92 | | -Der Backend-Server erstellt kein Standardkonto. Setze daher vor dem Start die Umgebungsvariablen `ADMIN_USERNAME` und `ADMIN_PASSWORD` (mindestens 12 Zeichen). |
| 96 | +To get started, you need to create a `.env` file in the `backend` directory. This file will store the necessary environment variables for the application to run correctly. |
93 | 97 |
|
94 | | -```bash |
95 | | -# Beispiel |
96 | | -export ADMIN_USERNAME=deinadmin |
97 | | -export ADMIN_PASSWORD=einSicheresPasswort123! |
| 98 | +**Example `backend/.env` file:** |
| 99 | + |
| 100 | +```env |
| 101 | +# The connection string for the SQLite database. |
| 102 | +DATABASE_URL=sqlite:./cms.db |
| 103 | +
|
| 104 | +# A secret key for signing JWT tokens. You can generate a strong secret using a password manager or a command-line tool. |
| 105 | +JWT_SECRET=your-super-secret-key-that-is-at-least-32-characters-long |
| 106 | +
|
| 107 | +# The credentials for the default admin account. |
| 108 | +ADMIN_USERNAME=admin |
| 109 | +ADMIN_PASSWORD=your-secure-password |
98 | 110 | ``` |
99 | 111 |
|
100 | | -Passe die Werte entsprechend deiner Umgebung an und starte den Server danach neu. |
| 112 | +Once you have created the `.env` file, you can start the backend server. |
101 | 113 |
|
102 | 114 | --- |
103 | 115 |
|
@@ -161,6 +173,8 @@ All editable content is stored as **JSON objects** that you can modify through a |
161 | 173 |
|
162 | 174 | **No database migrations needed** - just edit the JSON and save! ✨ |
163 | 175 |
|
| 176 | +The content you edit in the admin panel is saved to the SQLite database. When a user visits the website, the React frontend fetches this content from the backend API and dynamically renders the pages. This architecture allows for a fast, modern user experience while still providing a simple and powerful content management system. |
| 177 | + |
164 | 178 | --- |
165 | 179 |
|
166 | 180 | ## 🎨 Customization |
@@ -362,14 +376,14 @@ This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) |
362 | 376 |
|
363 | 377 | ## 🌟 Features Roadmap |
364 | 378 |
|
| 379 | +- [x] Dark mode theme |
| 380 | +- [x] Search functionality |
365 | 381 | - [ ] Multi-language support |
366 | | -- [ ] Dark mode theme |
367 | 382 | - [ ] Markdown editor with live preview |
368 | 383 | - [ ] Image upload and management |
369 | 384 | - [ ] SEO optimization tools |
370 | 385 | - [ ] Analytics dashboard |
371 | 386 | - [ ] Comment system |
372 | | -- [ ] Search functionality |
373 | 387 |
|
374 | 388 | --- |
375 | 389 |
|
|
0 commit comments