~jan0sch/smederee
Showing details for patch d1750405f9ce5d5da4a830a279663d648dab4755.
diff -rN -u old-smederee/README.md new-smederee/README.md --- old-smederee/README.md 2025-02-02 11:51:52.660262656 +0000 +++ new-smederee/README.md 2025-02-02 11:51:52.660262656 +0000 @@ -1,6 +1,6 @@ -# Smederee (plattdeutsch: Schmiede / low german: forge/smity) # +# Smederee (low german: forge/smithy) # -Eine einfache Plattform, auf der die Entwicklung von Software in Zusammenarbeit mit anderen erfolgen kann. +A frugal platform which is dedicated to help people build great software together. ## License ## @@ -22,15 +22,7 @@ During development you can start (and restart) the application via the `reStart` sbt task provided by the sbt-revolver plugin. -### Tests ### - -Tests are included in the project. You can run them via the appropriate sbt tasks -`test` and `IntegrationTest/test`. The latter will execute the integration tests. -Be aware that the integration tests might need a working database. - -## Deployment guide ## - -### Protecting endpoints +### Protecting endpoints ### If an endpoint is intended to be used only be users that are not yet logged in, then it should be implemented two times: @@ -40,75 +32,20 @@ - a simple redirect (`SeeOther`) or error page - put within a middleware with **fall through** -## Links - -- https://cheatsheetseries.owasp.org/cheatsheets/Session_Management_Cheat_Sheet.html -- https://cheatsheetseries.owasp.org/cheatsheets/JSON_Web_Token_for_Java_Cheat_Sheet.html -- https://owasp.org/Top10/ -- https://cheatsheetseries.owasp.org/cheatsheets/Forgot_Password_Cheat_Sheet.html - -## Basis MVP (ohne Details) - -Einfach heißt *einfach*, d.h. minimale Oberfläche ohne fancy Javascript, einfache HTML-Seiten mit etwas CSS. Ist dann auch schnell und funktioniert überall. - -### Code-Hosting - -1. Benutzerkonten und -gruppen sowie Berechtigungssystem -2. Code-Hosting mit Repos pro Konto (private und öffentliche) - 1. Zusammenfassung - 2. Codeansicht - 3. Versionen (Releases / Tags) herunterladen als Archiv (.tar.gz/.tar.xz) - 4. Klonen via HTTP (read-only) - 5. Klonen via SSH (read/write) -3. Unterstützung von darcs (später: git, hg, pijul) - -## Nächste Stufen - -### Code-Hosting - -* Historie anzeigen -* RSS für Historie (und Releases?) -* Unterstützung von git -* Zweige (Branches) anzeigen - * Konzept überlegen (Unterschiede darcs/git!!!) -* Forken zu eigenem Konto - -### Mailinglisten (ML) - -* pro Projekt mehrere aufsetzbar -* dienen als *Backend* für andere Komponenten - * Bugtracker - * automatische Mailingliste für Releases? - -### Bugtracker - -* nur *richtige* Tickets (bestätigte Fehler usw., keine *Feature-Wünsche* und so) - * Attribute überlegen und erstmal klein halten - * Zeiterfassung? -* Mailinglisten (ML) als *Backend* -* Ansicht u. Bearbeitung via Web, aber *nur Formulare* für das ML dahinter - -## Aussicht - -### Code-Hosting - -* Anmeldung auch via LDAP/OpenId-Connect (für SSO) - -### Bugtracker +### Tests ### -* Funktionalität für Kanban / Scrum (Board-Ansicht?) +Tests are included in the project. You can run them via the appropriate sbt tasks +`test` and `IntegrationTest/test`. The latter will execute the integration tests. +Be aware that the integration tests might need a working database. -### Dokumentations-Hosting +## Deployment guide ## -* automatisches Generieren aus Verzeichnis / Zweig im Code -* lediglich Markdown (vielleicht noch Asciidoc) unterstützen +TODO -### CI/CD +## Links ## -* *größeres Päckchen* ;-) -* könnte einfach und dreckig gemacht werden - * wie alle anderen: Travis etc., die nur in VMs was hochschießen und gucken ob `Exit-Code != 0` -* sauber: wie TeamCity, aber deutlich mehr Aufwand -* oder: Integration mit TeamCity? -* **noch kein klares Konzept -\> Diskussion**Simple code hosting. +[1]: https://owasp.org/Top10/ +[2]: https://cheatsheetseries.owasp.org/cheatsheets/Session_Management_Cheat_Sheet.html +[3]: https://cheatsheetseries.owasp.org/cheatsheets/JSON_Web_Token_for_Java_Cheat_Sheet.html +[4]: https://cheatsheetseries.owasp.org/cheatsheets/Forgot_Password_Cheat_Sheet.html