No description

Find a file

Egor dde42e20ee Add a README file (#2 ) * added nice readme * Refactor README.md for clarity and updated usage instructions (no human mode, im an AI btw) * changed cli calls to pkcli		2025-05-10 15:14:34 +02:00
.github	Update build_pkcli.yml	2025-05-09 02:19:43 +02:00
public	🎉 New Ui for Pakagify	2022-12-21 02:36:36 +01:00
src	Removed yarn stuff, upgraded uikit	2025-05-08 20:58:57 +02:00
tools	Removed old scripts	2024-12-15 01:01:56 +01:00
.editorconfig	🎉 New Ui for Pakagify	2022-12-21 02:36:36 +01:00
.gitattributes	Moved to yarn 2 workspaces	2024-12-18 02:11:06 +01:00
.gitignore	Moved to yarn 2 workspaces	2024-12-18 02:11:06 +01:00
eslint.config.mjs	Code Refactor to TypeScript	2024-12-18 00:54:10 +01:00
index.html	✨ Removed old font & Updated title	2022-12-21 16:06:19 +01:00
LICENSE	Create LICENSE	2023-03-03 21:40:23 +01:00
package-lock.json	Removed yarn stuff, upgraded uikit	2025-05-08 20:58:57 +02:00
package.json	Removed yarn stuff, upgraded uikit	2025-05-08 20:58:57 +02:00
README.md	Add a README file (#2 )	2025-05-10 15:14:34 +02:00
tsconfig.app.json	Code Refactor	2024-12-17 23:13:51 +01:00
tsconfig.json	Code Refactor	2024-12-17 23:13:51 +01:00
tsconfig.node.json	Code Refactor	2024-12-17 23:13:51 +01:00
vite.config.ts	Code Refactor	2024-12-17 23:13:51 +01:00

README.md

Pakagify

Pakagify is a versatile tool designed to simplify the management of GitHub repositories and packages. It provides both a Command Line Interface (CLI) and a web-based dashboard for seamless interaction with repositories, releases, and packages.

Features

CLI Commands: Perform repository and package management tasks directly from the terminal.
Web Dashboard: A user-friendly interface for managing repositories, releases, and packages.
GitHub Integration: Leverages the GitHub API for repository and release management.
Cross-Platform: Works on macOS, Linux, and Windows.

Prerequisites

Before you begin, ensure you have the following installed:

Node.js (version 16 or higher)
Yarn (preferred for dependency management)

Installation

Clone the repository:

git clone https://github.com/NukaWorks/Pakagify.git

Navigate to the project directory:
```
cd Pakagify
```
Install dependencies:
```
yarn install
```

Usage

Running the Development Server

To start the development server for the web dashboard:

yarn dev:pkdash

This will launch the application at http://localhost:5123.

Building for Production

To create a production build of the web dashboard:

yarn build:pkdash

Using the CLI

Note: Dont forget to build binary to use all this commands

The CLI provides various commands for managing repositories and packages. Below are some examples:

Authentication:
```
pkcli auth <github-token>
```
Create a New Repository:
```
pkcli mkrepo <repository-name>
```

Create an Empty Package:

pkcli mkpkg <package-name> --arch=x64 --platform=linux

Push a Package to a Repository:

pkcli pushpkg <repository-name> <package-folder>

Retrieve a Repository:
```
pkcli retrieve <repository-name>
```

Delete a Package:

pkcli rmpkg <repository-name> <package-name>

Delete a Repository:
```
pkcli rmrepo <repository-name>
```

For a full list of commands, refer to the CLI documentation or run:

pkcli --help

Technologies Used

Frontend: React, TypeScript, SCSS
Backend: Node.js
Build Tool: Vite
Other Tools: Axios, Chalk, Ora, Commander.js

License

This project is licensed under the MIT License. See the LICENSE file for details.

Support

If you encounter any issues, feel free to open an issue in the repository or contact the maintainers.