Episko - Software Project Management Tool

Episko is a lightweight tool designed to help developers manage their software projects efficiently. It provides a simple, metadata-based approach to organizing projects, making it easy to search, categorize, and retrieve project details.

🚀 Features

• User Authentication: Role-based access control (Admin, Author, User).
• Post Management: Create, edit, approve, archive, and delete posts.
• Admin Panel: Manage users and posts easily.
• Nginx Integration: Handles static files and reverse proxy setup.
• Docker Support: Simple deployment with Docker and Nginx.
• Multi-Device Compatibility: Works on desktop and mobile.

📂 Project Structure

.
├── .github/workflows/       # GitHub Actions for CI/CD
├── assets/                  # Static assets
├── certs/                   # SSL certificates (for local development)
├── data/                    # JSON storage for users and posts
├── docs/                    # Documentation & diagrams
├── nginx/                   # Nginx configuration
├── public/                  # Frontend static files (HTML, CSS, JS)
├── src/
│   ├── controllers/         # Business logic for authentication, posts, users
│   ├── middleware/          # Security & request handling middleware
│   ├── models/              # JSON-based models
│   ├── routes/              # API endpoints
│   ├── util/                # Utility functions
│   ├── views/               # Pug templates for rendering
│   ├── app.js               # Main entry point
├── docker-compose.yml       # Docker configuration
├── Dockerfile               # Deployment setup
├── package.json             # Node.js dependencies
├── setup_nginx.sh           # Nginx setup script
└── README.md                # This file!

🛠️ Installation & Setup

Installation.md

🔐 Security Considerations

⚠️ Note: Currently, user credentials are stored in data/users.json. While passwords are hashed, a proper database (e.g., PostgreSQL, SQLite) should be used in production.

• Ensure SSL certificates are properly configured in production.
• Protect the admin panel from unauthorized access.
• Implement rate-limiting and input validation for API security.

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

👨‍💻 Contributors

• Maximilian Rodler - @MaxRodler
• Paul Stöckle - @DosKobold
• Simon Blum - @DefinitelyNotSimon13
• Ben Oeckl - @benoeckl

📬 Contact

For feature requests or issues, open an issue on GitHub or reach us at [email protected].

---

💡 "No more lost projects. Stay organized with Episko." 🚀

---

AI Disclaimer

This file was generated by a LLM, as such only serves the purpose of looking nice and should in no way be interpreted as a legitimate source of information