Skip to content

Commit f428f1f

Browse files
feat: Add comprehensive documentation
Add JSDoc docstrings to all public functions, methods, and classes throughout the codebase. This includes components, context providers, pages, utility functions, and the API client. Update the main README.md to be a complete guide for new developers, covering the project's purpose, setup, and usage. This includes adding a "Project Purpose" section, clarifying the "Quick Start" and "How It Works" sections, and updating the "Features Roadmap."
1 parent cd9d0c6 commit f428f1f

41 files changed

Lines changed: 776 additions & 48 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,16 @@
1111

1212
**A professional, open-source content management system designed for creating beautiful tutorial websites with zero hassle.**
1313

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)
1515

1616
</div>
1717

1818
---
1919

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+
2024
## ✨ Features
2125

2226
### 🎨 Beautiful Default Design
@@ -89,15 +93,23 @@ npm run dev
8993

9094
### Admin-Anmeldung
9195

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.
9397

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
98110
```
99111

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.
101113

102114
---
103115

@@ -161,6 +173,8 @@ All editable content is stored as **JSON objects** that you can modify through a
161173

162174
**No database migrations needed** - just edit the JSON and save! ✨
163175

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+
164178
---
165179

166180
## 🎨 Customization
@@ -362,14 +376,14 @@ This project is licensed under the **MIT License** - see the [LICENSE](LICENSE)
362376

363377
## 🌟 Features Roadmap
364378

379+
- [x] Dark mode theme
380+
- [x] Search functionality
365381
- [ ] Multi-language support
366-
- [ ] Dark mode theme
367382
- [ ] Markdown editor with live preview
368383
- [ ] Image upload and management
369384
- [ ] SEO optimization tools
370385
- [ ] Analytics dashboard
371386
- [ ] Comment system
372-
- [ ] Search functionality
373387

374388
---
375389

0 commit comments

Comments
 (0)