<div align="center"> <img src="assets/icon-512x512.png" alt="logo" width="200" height="auto" /> <h1>Cocopasty</h1> <p> A simple copy-and-paste app to selfhost </p> <!-- Badges --> <p> <a href="https://github.com/MasterEvarior/cocopasty/graphs/contributors"> <img src="https://img.shields.io/github/contributors/MasterEvarior/cocopasty" alt="contributors" /> </a> <a href=""> <img src="https://img.shields.io/github/last-commit/MasterEvarior/cocopasty" alt="last update" /> </a> <a href="https://github.com/MasterEvarior/cocopasty/network/members"> <img src="https://img.shields.io/github/forks/MasterEvarior/cocopasty" alt="forks" /> </a> <a href="https://github.com/MasterEvarior/cocopasty/stargazers"> <img src="https://img.shields.io/github/stars/MasterEvarior/cocopasty" alt="stars" /> </a> <a href="https://github.com/MasterEvarior/cocopasty/issues/"> <img src="https://img.shields.io/github/issues/MasterEvarior/cocopasty" alt="open issues" /> </a> <a href="https://github.com/MasterEvarior/cocopasty/blob/master/LICENSE"> <img src="https://img.shields.io/github/license/MasterEvarior/cocopasty" alt="license" /> </a> </p> <h4> <a href="https://github.com/MasterEvarior/cocopasty/issues/new?assignees=MasterEvarior&labels=bug&template=bug_report.md&title=">Report Bug</a> <span> · </span> <a href="https://github.com/MasterEvarior/cocopasty/issues/new?assignees=MasterEvarior&labels=enhancement&template=feature_request.md&title=">Request Feature</a> </h4> </div> <br /> <!-- Table of Contents -->

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 -->

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 -->

Screenshots

<div align="center"> <img src="assets/screenshot.png" alt="screenshot" /> </div> <!-- TechStack -->

Tech Stack

<details> <summary>Client</summary> <ul> <li><a href="https://www.vuejs.org/">Vue.js</a></li> </ul> </details> <details> <summary>Server</summary> <ul> <li><a href="https://go.dev/">Golang</a></li> </ul> </details> <details> <summary>Database</summary> <ul> <li><a href="https://redis.io/">Redis</a></li> </ul> </details> <details> <summary>DevOps</summary> <ul> <li><a href="https://www.docker.com/">Docker</a></li> </ul> </details> <!-- Features -->

Features

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

<!-- Getting Started -->

Getting Started

<!-- Prerequisites -->

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 -->

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 -->

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 -->

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
  • [X] Automatically update Changelog for dependency updates
  • [ ] Automatic releases
  • [ ] Run tests

<!-- Contributing -->

Contributing

Contributions are always welcome!

<!-- FAQ -->

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 -->

License

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

<!-- Contact -->

Contact

Email: contact@giannin.dev

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

<!-- Acknowledgments -->

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