diff --git a/README.md b/README.md index c588b54..c48259a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,84 @@ -![Gopher](./src/static/img/gopher.png) -# FreePad \ No newline at end of file +![Gopher](./src/static/img/twitter_header_photo_2.png) +# **FreePad** +**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` + +![Gopher](./src/static/img/banner_prerequisites.png) + +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. + +![Gopher](./src/static/img/banner_environment.png) + +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! + +![Gopher](./src/static/img/banner_building.png) + + +## From Source +Building from source isn't exactly recommended as it's a hasle +```bash + +# Clone the repo +git clone https://github.com/JustKato/FreePad FreePad + +# Get in it! +cd FreePad + +# Install golang +sudo apt install golang # Obviously use your distro's package manager + +# Run the build Script +./build.sh + +# Check out the ./dist folder +cd ./dist + +# Make sure you change settings here +cp ../.env.example ./.env + +# Run the program +./freepad + +``` + +## Running the Binary +```bash +# Download the latest version of FreePad +freepad.1.0.3.zip + +# Extract to wherever +unzip freepad.1.0.3.zip + +# Get into the directory +cd FreePad + +# ( Optionaly but recommended ) Edit the .env file +vim .env + +# Run the program +./freepad + +``` + +## Starting with Docker-Compose [ WIP ] +```bash +# Copy the example docker-compose file to anywhere +wget https://raw.githubusercontent.com/JustKato/FreePad/master/docker-compose.example.yaml + +# Yoink the example .env file while we're at it +wget https://raw.githubusercontent.com/JustKato/FreePad/master/.env.example + +# Rename the files +mv docker-compose.example.yaml docker-compose.yaml +mv .env.example .env + +# ! Please take a look at the files and edit them before running +docker-compose up -d; +``` \ No newline at end of file diff --git a/src/static/img/banner_building.png b/src/static/img/banner_building.png new file mode 100644 index 0000000..509aff7 Binary files /dev/null and b/src/static/img/banner_building.png differ diff --git a/src/static/img/banner_building.png~ b/src/static/img/banner_building.png~ new file mode 100644 index 0000000..c794dfb Binary files /dev/null and b/src/static/img/banner_building.png~ differ diff --git a/src/static/img/banner_environment.png b/src/static/img/banner_environment.png new file mode 100644 index 0000000..4532042 Binary files /dev/null and b/src/static/img/banner_environment.png differ diff --git a/src/static/img/banner_environment.png~ b/src/static/img/banner_environment.png~ new file mode 100644 index 0000000..d7bf29f Binary files /dev/null and b/src/static/img/banner_environment.png~ differ diff --git a/src/static/img/banner_prerequisites.png b/src/static/img/banner_prerequisites.png new file mode 100644 index 0000000..c514326 Binary files /dev/null and b/src/static/img/banner_prerequisites.png differ diff --git a/src/static/img/banner_prerequisites.png~ b/src/static/img/banner_prerequisites.png~ new file mode 100644 index 0000000..03a3c0a Binary files /dev/null and b/src/static/img/banner_prerequisites.png~ differ diff --git a/src/static/img/facebook_cover_photo_1.png b/src/static/img/facebook_cover_photo_1.png new file mode 100644 index 0000000..e90fa11 Binary files /dev/null and b/src/static/img/facebook_cover_photo_1.png differ diff --git a/src/static/img/facebook_cover_photo_2.png b/src/static/img/facebook_cover_photo_2.png new file mode 100644 index 0000000..2c52d18 Binary files /dev/null and b/src/static/img/facebook_cover_photo_2.png differ diff --git a/src/static/img/facebook_profile_image.png b/src/static/img/facebook_profile_image.png new file mode 100644 index 0000000..2c5b2ce Binary files /dev/null and b/src/static/img/facebook_profile_image.png differ diff --git a/src/static/img/favicon.png b/src/static/img/favicon.png new file mode 100644 index 0000000..2013546 Binary files /dev/null and b/src/static/img/favicon.png differ diff --git a/src/static/img/gopher.png b/src/static/img/gopher.png index 71913a8..26ba851 100644 Binary files a/src/static/img/gopher.png and b/src/static/img/gopher.png differ diff --git a/src/static/img/instagram_profile_image.png b/src/static/img/instagram_profile_image.png new file mode 100644 index 0000000..415552d Binary files /dev/null and b/src/static/img/instagram_profile_image.png differ diff --git a/src/static/img/linkedin_banner_image_1.png b/src/static/img/linkedin_banner_image_1.png new file mode 100644 index 0000000..c06b58f Binary files /dev/null and b/src/static/img/linkedin_banner_image_1.png differ diff --git a/src/static/img/linkedin_banner_image_2.png b/src/static/img/linkedin_banner_image_2.png new file mode 100644 index 0000000..def272a Binary files /dev/null and b/src/static/img/linkedin_banner_image_2.png differ diff --git a/src/static/img/linkedin_profile_image.png b/src/static/img/linkedin_profile_image.png new file mode 100644 index 0000000..415552d Binary files /dev/null and b/src/static/img/linkedin_profile_image.png differ diff --git a/src/static/img/logo.png b/src/static/img/logo.png new file mode 100644 index 0000000..2c5b2ce Binary files /dev/null and b/src/static/img/logo.png differ diff --git a/src/static/img/logo_transparent.png b/src/static/img/logo_transparent.png new file mode 100644 index 0000000..98842fc Binary files /dev/null and b/src/static/img/logo_transparent.png differ diff --git a/src/static/img/pinterest_board_photo.png b/src/static/img/pinterest_board_photo.png new file mode 100644 index 0000000..0e0385b Binary files /dev/null and b/src/static/img/pinterest_board_photo.png differ diff --git a/src/static/img/pinterest_profile_image.png b/src/static/img/pinterest_profile_image.png new file mode 100644 index 0000000..18ad128 Binary files /dev/null and b/src/static/img/pinterest_profile_image.png differ diff --git a/src/static/img/twitter_header_photo_1.png b/src/static/img/twitter_header_photo_1.png new file mode 100644 index 0000000..cf31465 Binary files /dev/null and b/src/static/img/twitter_header_photo_1.png differ diff --git a/src/static/img/twitter_header_photo_2.png b/src/static/img/twitter_header_photo_2.png new file mode 100644 index 0000000..0f8c29f Binary files /dev/null and b/src/static/img/twitter_header_photo_2.png differ diff --git a/src/static/img/twitter_profile_image.png b/src/static/img/twitter_profile_image.png new file mode 100644 index 0000000..0e0385b Binary files /dev/null and b/src/static/img/twitter_profile_image.png differ diff --git a/src/static/img/youtube_profile_image.png b/src/static/img/youtube_profile_image.png new file mode 100644 index 0000000..0e0385b Binary files /dev/null and b/src/static/img/youtube_profile_image.png differ