simple comment
1.0.0
Simple Comment ist eine Kommentarplattform für jede Website. Kostenlos, flexibel, Open Source, privat und skalierbar.
Sehen Sie sich die Demo an: https://simple-comment.netlify.app
Hinweis: Die Moderationstools reichen noch nicht aus. Es gibt keine Benachrichtigung, wenn ein Benutzer einen Kommentar gepostet hat, und es gibt auch keine Möglichkeit, ihn vor der Genehmigung in Moderation zu halten. Wenn Ihnen dieses Projekt gefällt und Sie möchten, dass es innerhalb eines bestimmten Zeitplans weiterentwickelt wird, kontaktieren Sie mich. Ansonsten ist dieses Projekt noch auf dem Weg, aber auf dem langsamen Weg.
Die Mindestfunktionalität ist betriebsbereit!
Access-Control-Allow-Origin reagiert auf .env VariablenReferer -Header und die topicId müssen ordnungsgemäß zugeordnet werdenOrigin muss in der Access-Control-Allow-Origin Liste enthalten seinSimple Comment kann auf demselben Server wie Ihre Website oder auf einem separaten, domänenübergreifenden Server ausgeführt werden
Es ist erforderlich , dass Simple Comment über https bereitgestellt wird:
Befolgen Sie diese Anweisungen. Wenn etwas unklar ist, erstellen Sie bitte ein neues Problem
example.env in dasselbe Projektstammverzeichnis und benennen Sie es in .env um.env Ihre eigenen (erfundenen oder zufällig generierten) geheimen Werte für diese Einträge ein (dh ersetzen Sie alles rechts von = in jeder Zeile)..env den richtigen DB_CONNECION_STRING hinzuEnvironmental Variables auf die Schaltfläche Edit Variables.env den Schlüssel und den entsprechenden Wert für alle Variablen hinzuIS_CROSS_SITE den Wert true hinzu, wenn das Kommentarsystem in seiner eigenen Domäne gehostet wird, und false , wenn es sich um dieselbe Domäne handelt.<script src="[path-to]/simple-comment.js" defer></script> ( src muss auf die Datei simple-comment.js verweisen)<div id="simple-comment-display"></div>simple-comment.js in den Skriptordner Ihrer Website hochRefused to connect to 'api/auth' because it violates the following Content Security Policy directive: connect-src 'self'https://<your-comment-app>.netlify.app zu Ihrem Content Security Policy-Header neben connect-src hinzu (siehe https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers /Content-Security-Policy/connect-src)Access to fetch at 'https://<your-comment-app>.netlify.app/.netlify/functions/' from origin '<your-website>' has been blocked by CORS policy...<your-website> zum ALLOW_ORIGIN Schlüssel in .env und als Netlify-Umgebungsvariable hinzu login.html die Sie im Setup hochgeladen habenSIMPLE_COMMENT_MODERATOR_ID und SIMPLE_COMMENT_MODERATOR_PASSWORD in Ihrer .env Datei an Der Standard-Stack verwendet Netlify + MongoDB für das Backend und einen minimalen fetch -basierten Client für das Frontend. Er kann jedoch problemlos für die Verwendung jedes Technologie-Stacks angepasst werden, solange die Tests bestanden werden und die API der Open API 3-Schemadatei entspricht
Sie können Ihre eigene kostenlose MongoDB-in-the-Cloud erhalten, indem Sie diese Anweisungen befolgen
Setzt eine Unix-ähnliche Umgebung wie Ubuntu voraus.
nvm installnpm install -g yarnyarn installyarn run buildyarn run testyarn run test:e2esudo systemctl start mongod (siehe Linux)yarn run startDie API-Spezifikation wird durch die Datei simple-comment-openapi3.json im Open API 3-Format beschrieben und ist so konzipiert, dass sie mit jedem Backend, Frontend und Identifikationssystem austauschbar ist
Dies ist eine Übersicht über die Simple Comment API- Endpunkte
/comment Ein comment ist Text, den ein Benutzer als Antwort auf einen anderen comment oder ein topic postet. Die Präsentation dieser Antworten ist der einzige Grund, warum dieses Projekt existiert!
Der Kommentarendpunkt dient zum Erstellen, Lesen, Aktualisieren und Löschen (CRUD) einzelner Kommentare. Alle Kommentare müssen ein übergeordnetes Element haben, also etwas, auf das sie antworten, sei es ein topic oder comment
/topicEin Thema ist eine besondere Art von Kommentar, der standardmäßig nur von Administratorbenutzern erstellt werden kann und einen organisatorischen Bereich für antwortende Kommentare bildet. Es handelt sich um eine Art Stammkommentar und hat daher kein übergeordnetes Element
Der /topic-Endpunkt verarbeitet CRUD für diese Stammkommentare. Eine GET-Operation von /topic ruft eine Liste von Themen ab und GET auf /topic/{topicId} ruft alle Kommentare als Antwort auf dieses Thema und ihre Nachkommen ab
/userStandardmäßig können Kommentare von anonymen Benutzern gepostet werden, Simple Comment verfügt jedoch über ein minimales Identifizierungsschema, sodass Kommentatoren, die sich dafür entscheiden, gemäß den Richtlinien die Kontrolle über ihre Kommentare haben, nachdem sie gepostet wurden
/authAuth ist der Endpunkt für das Authentifizierungs- und Identifikationsschema. Ein Benutzer übermittelt seinen Benutzernamen und sein Kennwort an den Authentifizierungsendpunkt und erhält ein JSON Web Token (JWT), das ihn für andere CRUD-Vorgänge als dieser Benutzer authentifiziert
/verify Gibt die angemeldete Benutzer-ID oder 401 zurück
policy handelt es sich um ein Objekt mit Schlüssel-Wert-Paaren, das das Verhalten von Simple Comment regelt und beispielsweise die maximale Kommentarlänge bestimmt oder ob normale Benutzer sich selbst löschen können.
{
isGuestAccountAllowed : boolean , // if true, a visitor can post anonymously using a guest account. if false, only authenticated users can comment.
canFirstVisitCreateTopic : boolean , // if a discussion does not exist for a page, shall it be created when visited for the first time, or does admin create all topics?
canGuestCreateUser : boolean , // can a user with guest credentials create (their own) user profile? if 'canPublicCreateUser' is set to 'true' this setting is ignored
canGuestReadDiscussion : boolean , // can a user with guest credentials browse and read discussions? if 'canPublicReadDiscussion' is set to 'true' this setting is ignored
canGuestReadUser : boolean , // can a user with guest credentials view user profiles? if 'canPublicReadUser' is true, this setting is ignored
canPublicCreateUser : boolean , // can a user with no credentials create (their own) user profile?
canPublicReadDiscussion : boolean , // can a user with no credentials browse and read discussions?
canPublicReadUser : boolean , // can an anonymous visitor view any user's profile?
canUserDeleteSelf : boolean , // can a user delete their own profile?
maxCommentLengthChars : number , // Attempting to post a comment longer than this number of characters will be rejected by the API
} Es sind hier 34 Lösungen aufgeführt, die kein einfacher Kommentar sind. Fast alle davon sind ausgereifter als Simple Comment, und ich würde empfehlen, eines davon in Betracht zu ziehen, wenn Sie nicht speziell nach einer serverlosen, selbstgehosteten Open-Source-Lösung suchen. Nachfolgend sind jeweils die Vor- und Nachteile aufgeführt, die es von Simple Comment unterscheiden. Wenn „Vertrauen ist erforderlich“ aufgeführt ist, bedeutet dies, dass die Nutzung des Dienstes Vertrauen in das Unternehmen erfordert, da es Ihren Benutzern Closed-Source-Code bereitstellt, den Sie nicht kontrollieren und den Sie nicht einfach überprüfen können. Außerdem werden Benutzerdaten auf von ihnen kontrollierten Servern gespeichert. Diese Liste basiert auf öffentlicher Dokumentation, nicht auf Erfahrung. Wenn etwas falsch ist oder fehlt, lassen Sie es mich bitte wissen.
