aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorArianit Kukaj <arianit@hax.al>2025-05-26 17:31:13 +0000
committerArianit Kukaj <arianit@hax.al>2025-05-26 17:31:13 +0000
commitff29d90361059a7d3739bdff57922890a2edf4ea (patch)
tree27ce31d3ecaa1ecaaac4478ccaeda9c07e0087b1 /README.md
downloadKISSmoPerl-origin/HEAD.tar.gz
KISSmoPerl-origin/HEAD.zip
Diffstat (limited to 'README.md')
-rw-r--r--README.md61
1 files changed, 61 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e9b7d15
--- /dev/null
+++ b/README.md
@@ -0,0 +1,61 @@
+
+## Setting up and Running the KISSmo Perl
+
+To set up and run the Perl code you provided, follow the steps below. This guide assumes you are using a Unix-like system (e.g., Linux or *BSD or macOS) and have Perl installed.
+
+### Step 1: Install Required Modules
+
+Before running the code, you need to install the required Perl modules. Open your terminal and execute the following command:
+
+`cpanm Mojolicious DBI File::Slurp`
+
+or
+
+`cpan install Mojolicious::Lite`
+
+`cpan install DBI`
+
+`cpan install File::Slurp`
+
+This command uses the `cpanm` tool to install the necessary modules (`Mojolicious`, `DBI`, and `File::Slurp`). If you don't have `cpanm` installed, you can install it by running `cpan App::cpanminus`.
+
+### Step 2: Create the SQLite Database
+
+The code uses an SQLite database to store the pastes. Create an empty SQLite database file named `pastes.db` in the same directory as the Perl script. You can do this with the following command:
+
+`touch pastes.db && mkdir pastes`
+
+
+### Step 3: Run the Perl Script
+
+Once you have installed the modules and created the database file, you can run the Perl script. Open your terminal and navigate to the directory containing the script (`cd path/to/script`). Then execute the following command:
+
+`perl paste.pl daemon -m production -l http://0.0.0.0:7878`
+
+This command starts the Mojolicious application as a daemon process. You should see output similar to:
+
+`[Sun Jun 23 12:34:56 2023] [info] Listening at "http://ip:7878"`
+
+### Step 4: Access the Application
+
+Open a web browser and visit `http://ip:7878` to access the application. You should see a web page with a text area where you can enter your content.
+
+### Step 5: Test the Application
+
+You can test the application by entering some content in the text area and clicking the "Create paste" button. The application will generate a unique ID for the paste and display the paste's details.
+
+### Step 6: Accessing Raw Paste Data
+
+To access the raw content of a paste, you can click the "RAW" button on the paste's detail page.
+
+That's it! You have successfully set up and run the Perl script. You can continue using the application by creating and accessing pastes through the web interface.
+
+**Note**: Remember to keep the terminal running while you want the application to be accessible. You can stop the application by pressing Ctrl+C in the terminal.
+
+# KISSmo 1.1.7 Release note
+
+https://github.com/hedho/KISSmoPerl/releases/tag/v1.1.7
+
+### Demo:
+
+https://paste.hax.al/