Skip to content

📦 Installation

Get ShareJadPi Running in 5 Minutes

Follow these simple steps to install and run ShareJadPi on your machine.

✅ Prerequisites

Before installing ShareJadPi, make sure you have:

  • [ ] Python 3.7 or higher installed
  • [ ] Terminal/Command Prompt access
  • [ ] Git (optional, for cloning the repository)
  • [ ] 5 minutes of your time

Check If You Have Python

Open your terminal and run:

bash
python --version

You should see something like:

Python 3.11.5

Don't have Python? Download it here →

💡 Windows users: During Python installation, check "Add Python to PATH"

🚀 Installation Methods

Choose the method that works best for you:

Method 2: Download ZIP

No Git required, simple download

Use this method →

Method 1: Git Clone

Step 1: Clone the Repository

Open your terminal and run:

bash
git clone https://github.com/hetcharusat/sharejadpi.git
cd sharejadpi/SGP_phase1

Step 2: Install Dependencies

bash
pip install flask werkzeug
💡 Tip: Use a virtual environment for cleaner installations:
bash
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install flask werkzeug

Step 3: Run ShareJadPi

bash
python sharejadpi-dev.py

That's it! 🎉


Method 2: Download ZIP

Step 1: Download

  1. Visit https://github.com/hetcharusat/sharejadpi
  2. Click the Code button
  3. Select Download ZIP
  4. Extract the ZIP file

Step 2: Navigate to Folder

Open terminal in the extracted folder:

bash
cd sharejadpi-main/SGP_phase1

Step 3: Install Dependencies

bash
pip install flask werkzeug

Step 4: Run ShareJadPi

bash
python sharejadpi-dev.py

Done! ✨


📱 First Launch

When you run ShareJadPi for the first time, you'll see:

ShareJadPi Development Server v4.5.4-dev
==========================================

✓ Upload folder created: /Users/you/ShareJadPi-Dev/uploads

📡 Server running on:
   → Local:   http://127.0.0.1:5000
   → Network: http://192.168.1.100:5000

🌐 Access from other devices:
   1. Connect to the same Wi-Fi
   2. Open: http://192.168.1.100:5000

🚀 Opening browser...
Success! Your browser should open automatically showing the ShareJadPi interface.

What Just Happened?


🔧 Configuration Options

Custom Port

By default, ShareJadPi runs on port 5000. To use a different port:

bash
python sharejadpi-dev.py --port 8080

Don't Open Browser

If you don't want the browser to open automatically:

bash
python sharejadpi-dev.py --no-browser

Combine Options

bash
python sharejadpi-dev.py --port 3000 --no-browser

🌐 Accessing from Other Devices

Step 1: Get Your Network IP

ShareJadPi displays your network IP when it starts:

Network: http://192.168.1.100:5000
         ^^^ This is your IP ^^^

Step 2: Connect Devices to Same Wi-Fi

All devices must be on the same Wi-Fi network as the computer running ShareJadPi.

Step 3: Open the URL

On any device (phone, tablet, another computer):

  1. Open a web browser
  2. Type the network URL: http://192.168.1.100:5000
  3. Press Enter

You should see the ShareJadPi interface! 🎉


🐛 Troubleshooting

Problem: "Python not found"

Solution:

  1. Install Python from python.org
  2. On Windows, reinstall and check "Add to PATH"
  3. Restart your terminal

Problem: "No module named 'flask'"

Solution:

bash
pip install flask werkzeug

If that doesn't work:

bash
python -m pip install flask werkzeug

Problem: "Address already in use"

Solution:

Another program is using port 5000. Either:

Option 1: Use a different port

bash
python sharejadpi-dev.py --port 8080

Option 2: Stop the other program using port 5000

On Windows:

powershell
netstat -ano | findstr :5000
taskkill /PID <PID> /F

On Mac/Linux:

bash
lsof -ti:5000 | xargs kill -9

Problem: Can't access from other devices

Check:

  1. ✅ All devices on same Wi-Fi?
  2. ✅ Using the Network URL (not localhost)?
  3. ✅ Firewall allowing connections?

Windows Firewall Solution:

ShareJadPi may ask for firewall permission. Click Allow Access.

If you missed it, manually allow Python:

powershell
# Run as Administrator
New-NetFirewallRule -DisplayName "ShareJadPi" -Direction Inbound -Program "C:\Path\To\python.exe" -Action Allow

Problem: Browser doesn't open automatically

Solution:

This is normal on some systems. Just manually open:

http://localhost:5000

Or use --no-browser flag to suppress the message.


📂 File Locations

Where Are Uploaded Files Stored?

All uploaded files are saved to:

Windows:

C:\Users\YourName\ShareJadPi-Dev\uploads

Mac/Linux:

/Users/YourName/ShareJadPi-Dev/uploads

You can access this folder anytime to:

  • View uploaded files
  • Copy files elsewhere
  • Delete old files
  • Backup files

⚙️ System Requirements

Minimum Requirements

  • OS: Windows 7+, macOS 10.12+, or Linux
  • Python: 3.7+
  • RAM: 512 MB
  • Disk: 100 MB for application + storage for files
  • Network: Wi-Fi or Ethernet connection
  • OS: Windows 10/11, macOS 12+, Ubuntu 20.04+
  • Python: 3.10+
  • RAM: 1 GB+
  • Disk: SSD for faster file operations
  • Network: Gigabit Ethernet for max speed

🎯 Next Steps

You've successfully installed ShareJadPi! 🎉

Now let's learn how to use it:

Continue to First Steps →

Other Helpful Pages


🆘 Still Having Issues?

Need help? We're here for you:


Built with ❤️ by Het Charusat