Skip to content

Latest commit

 

History

History
113 lines (75 loc) · 3.22 KB

INSTALL.md

File metadata and controls

113 lines (75 loc) · 3.22 KB

Installing and Running Pagu

This document provides detailed instructions on how to install and run Pagu for development purposes.

Prerequisites

Before proceeding, ensure that your system meets the following requirements:

  • Go: Pagu is developed using the Go programming language. You can find installation instructions here.
  • Database: Pagu uses MySQL as its primary database in production. For local development, you can use SQLite.

Installation Steps

Follow these steps to install and configure Pagu on your local machine:

1. Clone the Repository

Clone the Pagu repository to your local machine:

git clone https://github.com/pagu-project/pagu.git
cd pagu

2. Install Development Tools

Install the necessary development tools by running:

make devtools

3. Running Local Pactus Nodes (Optional)

You can run local Pactus nodes and configure them in your config.yml. Refer to the Pactus Daemon documentation. Alternatively, Pagu can fetch information from public nodes without requiring a local node.

4. Wallet Requirements (Optional)

Pagu requires a Pactus wallet to manage transactions. If you don’t have a wallet, follow the instructions to create one. A wallet is essential for sending transactions through Pagu.

5. Discord Setup (Optional)

If you plan to run Pagu on a Discord server, you will need a Guild ID and a Discord application token. These can be obtained by following the Discord Developer Guide.

6. Telegram Setup (Optional)

If you plan to run Pagu on Telegram, you will need a Telegram Bot Token.

Running Pagu

Run Pagu using the Command-Line Interface (CLI) without the need for integration into Discord or Telegram. Use the following command:

go run ./cmd/cli -c ./config/config.sample.yml run

Contributing

We are excited to welcome contributions to Pagu! To get started, follow these steps:

  1. Fork the Repository Create a fork of the Pagu repository in your GitHub account.

  2. Create a New Branch Create a feature-specific branch for your work:

    git checkout -b feature/YourFeature

  3. Make Your Changes Implement your feature or fix as needed.

  4. Build and Test Your Changes Ensure your changes build successfully and pass all tests:

    make build
make test

  5. Follow Linting and Code Conventions Verify that your code adheres to Pagu's linting rules and coding standards:

    make check

  6. Commit Your Changes Write a clear and concise commit message describing your changes:

    git commit -m "Add feature: YourFeature"

  7. Push to Your Branch Push your changes to the branch in your forked repository:

    git push origin feature/YourFeature

  8. Open a Pull Request (PR) Submit a Pull Request to the original Pagu repository. Include a detailed description of your changes and reference any related issues.