learnit

Lerne

Eine einfache, einfach zu bedienende und kostenlose Lernplattform für alle.

Was ist Learnit?

Learnit ist eine Plattform, auf der jeder Codierung lernen kann. Es ist ein kostenloses und Open -Source -Projekt, das sich derzeit in der Entwicklung befindet. Fühlen Sie sich frei, um zum Projekt beizutragen, indem Sie das Repository verlassen und eine Pull -Anfrage stellen (mehr dazu im Abschnitt mit Beitrag).

Haftungsausschluss

Die Entwicklungsversion verwendet https://cors-anywhere.herokuapp.com/corsdemo um Kors zu umgehen. Dies ist keine gute Praxis und sollte in der Produktion nicht verwendet werden. Dies gilt nur für Entwicklungszwecke. Um es zum Laufen zu bringen, müssen Sie die Site öffnen und auf Request temporary access to the demo server klicken.

Aufstellen

1. Klonen des Repository git clone https://github.com/Style77/learnit.git
2. Installieren Sie Abhängigkeitsgarn yarn install
3. Setup .env.local Datei:

 # Firebase config
apiKey=
authDomain=
projectId=
storageBucket=
messagingSenderId=
appId=
measurementId=

# local server url - website adds /api to the end
apiUrl="http://localhost:3000"


# jdoodle.com config - its used for compiling code in lessons
jdoodleClientId=
jdoodleClientSecret=

4. Führen Sie das Projektgarn yarn dev durch

Beitragen

Wenn Sie zum Projekt beitragen möchten, können Sie dies tun, indem Sie das Repository verlassen und eine Pull -Anfrage erstellen. Wenn Sie Fragen haben, können Sie mich unter Discord: yves#8382 kontaktieren. Jeder Beitrag wird geschätzt und wir werden Ihnen Anerkennung dafür geben (insbesondere jeder Autor neuer Lektionen, das den Abschnitt "Lektionen im Modelle" überprüft).

Modelle

Unterrichtsmodell

Das Lehrenformat basiert auf der folgenden Formel:

• Die Lektionen werden in data/courses/[language]/lessons gespeichert, jeder Unterrichtsname lautet eine Nummer (z. B. 1.json ) und wird zum Sortieren von Lektionen verwendet.
• Die Unterrichtsdatei ist eine JSON -Datei mit der folgenden Struktur:

{
    "title" : " " ,                // lesson title
    "description" : " " ,          // this is not used anywhere yet, but can be used to display description in the future (or help with SEO)
    "number" : 1 ,                // number of lesson
    "tags" : [],                 // tags for lesson (e.g. "arrays", "loops", "functions") - not used anywhere yet
    "examples" : [               // examples for lesson
        {
            "title" : " " ,        // example title
            "description" : " " ,  // example description - it's shown on the left side of editor
            "code" : " " ,         // example code - it's shown in editor on the right side - not needed if u want user to write code from scratch
            "output" : " "        // example output - it needs to be same as output from code written by user to let user pass the example (or lesson if there is only one example)
        },
        {                       // there can be multiple examples in one lesson - user needs to pass all of them to pass the lesson (or there can be only one example in lesson)
            "title" : " " ,
            "description" : " " ,
            "code" : " " ,
            "output" : " "
        }
    ]
}

Lizenz

Dieses Projekt ist unter der MIT -Lizenz lizenziert - finden Sie in der Lizenzdatei Einzelheiten

Todo

• Ändern Sie die Beschreibung der Kurse in Constants.js und fügen Sie weitere Kurse hinzu
• Änderungen erlaubten Domains in next.config.js zu einigen Image -Proxy wie https://cloudinary.com/
• Aktualisieren Sie README.md und LICENSE
• Update Reposcount alle paar Tage (dafür sollte ein Cron -Job dafür vorhanden sein)
• Fügen Sie mehr Lektionen hinzu

Verwendet in Learnit

• Weiter.js

• Firebase

• jdoodle.com

• React-Icons

• Showdown

• Die Ikonen für Kurse stammen hauptsächlich von Wikimedia Commons und offiziellen Websites der Sprachen und Frameworks

Autoren

• Stil - Entwicklung
• Kluczi - Entwicklung