bharathganji / pikpak-plus

https://pikpak-plus.com
GNU General Public License v3.0
36 stars 4 forks source link
ionic jackett pikpak pikpak-plus share supabase

Contributors Forks Stargazers Issues LinkedIn


Logo

unofficial implementation of PikPak

Share your PikPak [Premium] with your friends and family!
Explore the docs »

Installation Demo (coming soon) · Android Apk · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

Note:

App Home

Download Drawback:

solution:

  1. Rename the file after download (already an action provided to click and copy file/folder name).
  2. use 3rd party downloaders, provide the link and name and start download. (IDM, ADM, NAVI, etc...).

Built With

The application is containarized so that you don't need to go through the hassle of installing dependencies, tech stack used to built this application is listed below.

Getting Started

This project is focused to run on server environment hence docker containers are used to deploy the application.

Prerequisites

Installation

  1. Clone the repo

    git clone https://github.com/bharathganji/pikpak-plus.git
  2. Create .env file inside the project root folder, add the following to it (refer example.env)

    # pikpak email, password (Required)
    user = example@example.com
    passwd = example
    
    # Supabse Project URL, anon public-key (Required)
    SUPABASE_URL = https://example.supabase.co
    SUPABASE_KEY = example string key
    
    # Jackett API key and domain (optional)
    # if you want to use search Functionality (Required)
    JACKETT_API_KEY = string key
    JACKET_DOMAIN = https://jackett.example
    
    # api hostname/URL if deployed external else dont change eg:'https://api.example.com/'
    VITE_PIKPAK_PLUS_API = 'http://server:5000'
    
    # UI Domain Name (optional)
    VITE_HOSTNAME = 'https://example.com'
    
    # Ports (optional)
    VITE_DEVELOPMENT_PORT = "3001"
    VITE_PRODUCTION_PORT = "3002"
  3. Create Table and enable RLS policies in supabase

    Logo Logo Logo
  4. Run the containers

    sudo docker compose -f "docker-compose.yml" up -d --build
  5. [optional] in case server exposed via endpoint or tunnel create cron-job or manually to hit end-point /ping every 2 hours.
    eg: api.pikpak-plus.com/ping

AndroidApk

Usage

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the GNU General Public License v3.0. See LICENSE for more information.

Contact

Bharath Ganji - @bharathganji - bharathganji1@gmail.com

Project Link: https://github.com/bharathganji/pikpak-plus

Acknowledgements