codether

Codéther

️ ATTENTION: Ce projet est en cours de développement. Certaines fonctions peuvent ne pas être disponibles ou fonctionner incorrectes.

Codeether est une application Web complète, un analogue de Pastebin, qui permet aux utilisateurs d'enregistrer n'importe quel code jusqu'à 10 Mo sans enregistrement. L'application fournit également une API ouverte et utilise l'éditeur de Monaco Editor (Analogue du code Visual Studio). Particularités

• Préservation du code: les utilisateurs peuvent enregistrer n'importe quel code sur 10 Mo.
• Sans inscription: l'inscription n'est pas tenue d'utiliser le service.
• Éditeur de Monaco: Éditeur de code construit comme Visual Studio Code.
• API ouvert: API pour l'interaction avec l'application.

Futurs addons

• Ajout de sockets pour modifier plusieurs utilisateurs: la possibilité d'un code d'édition conjoint en temps réel. ⌛
• Architecture de fichiers: support pour travailler avec des fichiers et des réalisateurs, ce qui permettra aux utilisateurs d'organiser leurs projets plus efficacement.
• Base de données Mastrated: Traduction du stockage de code de PostgreSQL à S3 ✅

Technologies

• Backend: NESTJS (TypeScript)
• Frontend: Vuejs (TypeScript)
• SSR: Nuxt
• DB: Postgesql, S3, redis
• Broker: Apache Kafka

Particularités

• Préservation du code : les utilisateurs peuvent enregistrer n'importe quel code sur 10 Mo.
• Sans inscription : l'inscription n'est pas tenue d'utiliser le service.
• Éditeur de Monaco : Éditeur de code construit comme Visual Studio Code.
• API ouvert : API pour l'interaction avec l'application.

Lancement et installation

Exigences préliminaires

Assurez-vous que vos programmes suivants sont installés:

• Node.js (version LTS recommandée)
• Fil

Cloner le référentiel

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

Installation de dépendances

 cd frontend
yarn install
cd ../backend
yarn install

Lancement du serveur backend

Accédez au répertoire du serveur et exécutez le serveur:

 cd backend
yarn start

Lancement de serveurs frappés

Accédez au répertoire client et exécutez le serveur:

 cd frontend
yarn serve

L'application sera disponible sur http: // localhost: 8080. API ouvert

L'API fournit les entousons suivantes:

En savoir plus dans Swagger par / Docs

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

Un exemple de demande

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

Structure du projet

Frapper

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

Contribution au projet

Si vous souhaitez contribuer au projet, veuillez créer un problème de demande de traction ou d'ouverture dans le référentiel.

Licence

Ce projet est autorisé sous la licence du MIT. Pour plus de détails, consultez le fichier de licence.