mirror of https://github.com/JustKato/FreePad.git
33 lines
2.3 KiB
Markdown
33 lines
2.3 KiB
Markdown
|
|
|
|
Quickly create "pads" and share with others
|
|
|
|
[](https://hub.docker.com/r/justkato/freepad)
|
|
[](https://ko-fi.com/justkato)
|
|
|
|
[](https://pad.justkato.me/)
|
|
|
|
|
|
# **FreePad V2**
|
|
|
|
**FreePad** is a simple `Go` project to help you juggle temporary notes that you might wanna pass from one device to another, or from a person to another with memorable and easy to communicate online "Pads".
|
|
|
|
The project is absolutely free to use, you can extend the code and even contribute, I am more than happy to be corrected in my horrible beginner code.
|
|
|
|
The current maintainer and creator is `Kato Twofold`
|
|
|
|
## Why version 2?
|
|
|
|
Version 2 has been initialized to rewrite everything and applying what I have learned from v1, I am new to go and I haven't followed the best of best practices and I know for a fact I can do better, so V2 has been pushed.
|
|
|
|
|
|
|
|
Before getting started there are a couple things you should configure before proceeding, such as the database storage type and a couple limits, now if you really want to you can skip these but it's better to know what you're running as to not wake up with a not-so-nice surprise.
|
|
|
|
|
|
|
|
The `.env` file contains all of the available options and you should use it to change those said variables, these are really important to customizing and self hosting this experience for yourself.
|
|
|
|
If you need any help with any setting you can always open an issue over on github and get help from me.
|
|
|
|
If you are barely getting started with hosting your own services, or even Sys admin stuff in general or writing code my suggestion is to just copy `.env` and leave it as is until you get it running with the defaults running fine, afterwards you can play with it a little and who knows, maybe even get to learn something! |