codether

Codeether

️ Attention: This project is under development. Some functions may not be available or work incorrect.

Codeether is a complete web application, an analogue of Pastebin, which allows users to save any code up to 10MB without registration. The application also provides an open API and uses the editor of Monaco Editor (analogue of Visual Studio Code). Peculiarities

• Code preservation: Users can save any code to 10MB.
• Without registration: registration is not required to use the service.
• Monaco Editor: Built -in code editor similar to Visual Studio Code.
• Open API: API for interaction with the application.

Future addons

• Adding sockets for editing several users: the possibility of joint editing code in real time. ⌛
• File architecture: support for working with files and directors, which will allow users to organize their projects more efficiently.
• Mastrated database: Translation of code storage from postgresql to S3 ✅

Technologies

• Backend: Nestjs (Typescript)
• Frontend: Vuejs (Typescript)
• SSR: Nuxt
• Db: postgesql, s3, redis
• Broker: Apache Kafka

Peculiarities

• Code preservation : Users can save any code to 10MB.
• Without registration : registration is not required to use the service.
• Monaco Editor : Built -in code editor similar to Visual Studio Code.
• Open API : API for interaction with the application.

Launch and installation

Preliminary requirements

Make sure your following programs are installed:

• Node.js (recommended LTS version)
• Yarn

Cloning the repository

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

Installation of addictions

 cd frontend
yarn install
cd ../backend
yarn install

Launch of the Backend server

Go to the Server directory and run the server:

 cd backend
yarn start

Launch of Frontened servers

Go to the Client directory and run the server:

 cd frontend
yarn serve

The application will be available at http: // localhost: 8080. Open API

API provides the following entoons:

Read more in Swagger by /docs

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

An example of a request

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

Project structure

Bash

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

Contribution to the project

If you want to contribute to the project, please create Pull Request or open Issue in the repository.

License

This project is licensed under the MIT license. For more details, see License file.