Cocopasty

A simple copy-and-paste app to selfhost

Report Bug · Request Feature

Table of Contents

• About the Project
  • Screenshots
  • Tech Stack
  • Features
• Getting Started
  • Configuration
  • Prerequisites
  • Run Locally
  • Deployment
• Roadmap
• Contributing
• FAQ
• License
• Contact
• Acknowledgements

About the Project

Cocopasty is a small and simply copy-and-paste solution for your code. Paste your code in your browser and copy it on another device!

Screenshots

Tech Stack

Client

• Vue.js

Server

• Golang

Database

• Redis

DevOps

• Docker

Features

• So simple, your pet rock could use it
• 150+ available languages
• Autodetect languages with highlight.js
• Completely dockerized

Getting Started

Prerequisites

You need to have Go, Docker, Docker Compose and NPM installed to run/develop this project.

Configuration

Explanations for the different environment variables. Examples can be found in the docker-compose.yml files.

Frontend

• VUE_APP_BACKEND_PORT is the port your cocopasty-backend container runs.
• VUE_APP_BACKEND_HOST is the host of your cocopasty-backend container.

Backend

• LOG_LEVEL the log level you wish to use. Default is "info". All log levels can be found here.
• REDIS_HOST is the host + port of your Redis DB.
• REDIS_PASSWORD if your Redis instance uses password authentication, set here your password. If left empty, authentication without password will be tried.

Run Locally

Clone the project

  git clone https://https://github.com/MasterEvarior/cocopasty.git

Go to the project directory

  cd cocopasty

Run with Docker Compose

  docker-compose up

Deployment

Docker Compose

To deploy this project copy the contents of the docker-compose-deploy.yml file and paste it into a new file.

  wget https://raw.githubusercontent.com/MasterEvarior/cocopasty/main/docker-compose-deploy.yml

Change the ports, volumes, etc. to your liking.

  vi docker-compose-deploy.yml

Rename the file and run it with Docker Compose.

  mv docker-compose-deploy.yml docker-compose.yml
  docker-compose up

Roadmap

Feel free to suggest features through a GitHub issue, in addition to the ones listed below:

• Backend tests
• Frontend tests
• Installation instructions for Unraid
• CI/CD with GitHub-Actions
  • Automatically update Changelog for dependency updates
  • Automatic releases
  • Run tests

Contributing

Contributions are always welcome!

FAQ

• Is there an official method to install WITHOUT Docker?

  • No

• Is there any sort of build in authentication?

  • No, though you could use something like Authelia

• Can I use this to copy my API-Keys etc. from one device to another?

  • You can but I'd strongly advise against it

• Which languages are available for auto-highligting?

  • A complete list can be found here

• Can I use this with my already existing Redis instance?

  • Sure, you just have to adjust the compose file to your liking

• Does the default compose file configure Redis to be persistent?

  • No

License

Distributed under the MIT License. See the LICENSE file for more information.

Contact

Email: contact@giannin.dev

Project Link: https://github.com/MasterEvarior/cocopasty

Acknowledgements

Cool projects which make Cocopasty possible

• Shields.io
• Awesome Readme Template
• highlight.js
• Vue Prism Editor
• Guide to Vue.js + Docker env variables
• CSS Button Generator