codether

Codeether

Euen Achtung: Dieses Projekt befindet sich in der Entwicklung. Einige Funktionen sind möglicherweise nicht verfügbar oder arbeiten falsch.

Codeether ist eine vollständige Webanwendung, ein Analogon von Pastebin, mit dem Benutzer ohne Registrierung jeden Code bis zu 10 MB speichern können. Die Anwendung bietet auch eine offene API und verwendet den Herausgeber des Monaco Editors (Analogue of Visual Studio Code). Besonderheiten

• Code -Erhaltung: Benutzer können jeden Code auf 10 MB speichern.
• Ohne Registrierung: Die Registrierung ist nicht erforderlich, um den Dienst zu nutzen.
• Monaco Editor: Erbaut -in -Code -Editor ähnlich wie Visual Studio Code.
• Öffnen Sie die API: API für die Interaktion mit der Anwendung.

Zukünftige Addons

• Hinzufügen von Sockets für die Bearbeitung mehrerer Benutzer: die Möglichkeit eines gemeinsamen Bearbeitungscode in Echtzeit. ⌛
• Dateiarchitektur: Unterstützung für die Arbeit mit Dateien und Direktoren, mit denen Benutzer ihre Projekte effizienter organisieren können.
• Mastrated Database: Übersetzung des Codespeichers von PostgreSQL nach S3 ✅

Technologien

• Backend: NestJs (TypeScript)
• Frontend: VueJS (TypeScript)
• SSR: Nuxt
• DB: Postgesql, S3, Redis
• Broker: Apache Kafka

Besonderheiten

• Code -Erhaltung : Benutzer können jeden Code auf 10 MB speichern.
• Ohne Registrierung : Die Registrierung ist nicht erforderlich, um den Dienst zu nutzen.
• Monaco Editor : Erbaut -in -Code -Editor ähnlich wie Visual Studio Code.
• Öffnen Sie die API : API für die Interaktion mit der Anwendung.

Start und Installation

Voranforderungen

Stellen Sie sicher, dass Ihre folgenden Programme installiert sind:

• Node.js (Empfohlene LTS -Version)
• Garn

Klonen des Repositorys

git clone https://github.com/yourusername/codether.git
cd codether

Installation von Abhängigkeiten

 cd frontend
yarn install
cd ../backend
yarn install

Start des Backend Servers

Gehen Sie zum Serververzeichnis und führen Sie den Server aus:

 cd backend
yarn start

Start von Frontened Servern

Gehen Sie zum Client -Verzeichnis und führen Sie den Server aus:

 cd frontend
yarn serve

Die Anwendung wird unter http: // localhost: 8080 erhältlich sein. Open API

API liefert die folgenden Entos:

Lesen Sie mehr in Prahlerei von /docs

 POST /api/code/create - Сохранить новый код.
POST /api/code/get/:shortid - Получить сохраненный код по ID.
POST /api/code/update/:shortid - Обновление кода

Ein Beispiel für eine Anfrage

curl -X POST http://localhost:3000/api/code/create -H " Content-Type: application/json " -d ' {"code": "console.log("Hello World");"} '

Projektstruktur

Verprügeln

 codether/
├── frontend/          # VueJS frontend
│   ├── src/
│   ├── public/
│   └── ...
├── backend/          # NestJS backend
│   ├── src/
│   ├── test/
│   └── ...
├── README.md
└── package.json

Beitrag zum Projekt

Wenn Sie zum Projekt beitragen möchten, erstellen Sie bitte eine Pull -Anfrage oder öffnen Sie das Problem im Repository.

Lizenz

Dieses Projekt ist unter der MIT -Lizenz lizenziert. Weitere Informationen finden Sie unter Lizenzdatei.