Skip to content

BUILDING.md

Latest commit

 

History

History
96 lines (69 loc) · 2.96 KB

BUILDING.md

File metadata and controls

96 lines (69 loc) · 2.96 KB
Raw

Building automatically using GitHub actions

This repository has two workflows to build the project:

  • Release: Automatically builds, releases and deploys when a new tag is pushed
    1. The project is compiled for production
    2. A new release gets posted in the GitHub repository, using contents of latest-version-changelog.md as release body and a zip of build results as an attachment
    3. The build compiled project is pushed to the DIBgram GitHub Pages repository
  • Build and deploy to beta GH pages: Automatically builds DIBgram after each commit and deploys to https://DIBgram.github.io/beta
    1. The project is compiled
    2. Compilations results are pushed to beta GH Pages repo

These workflows use GitHub secrets API_ID and API_HASH, which should be obtained from https://my.telegram.org for forks.

Creating config file

The config file contains Telegram API credentials and some options.
It is needed to compile DIBgram, but is automatically created in build workflows.

  1. Obtain your API credentials from my.telegram.org

  2. Create file src/dibgram/TdWeb/config.js and use this template to create the config file:

    export function getCredentials() {
    return {
        api_id: 123456,
        api_hash: 'abcdefghijklmnopqrstuvwxyz'
    };
}

export function getConfig() {
    return {
        log: {
            log_updates: true or false,
            log_queries: true or false
        }
    };
}

    Make sure to replace these fields with their correct value:

    • api_id: API ID from my.telegram.org

    • api_hash: API Hash from my.telegram.org

    • log_updates: true if you want updates received from TdLib to be shown in developer tools console, otherwise false (recommended false)

    • log_queries: true if you want updates received from TdLib to be shown in developer tools console, otherwise false (recommended false)

Running app in test mode

You can run the app in test mode which is faster and better suited for development, and supports hot reload (changes are applied while the app is running).

  1. Clone DIBgram repository

    git clone github.com/DIBgram/DIBgram.git
cd DIBgram

  2. Obtain API ID and API hash, and create config.js

  3. Install all dependencies

    npm install

  4. Run app

    npm start

After doing this, DIBgram will automatically open by opening a browser window at http://localhost:3000.

Building for production

You can create an optimized build of DIBgram, for use in production.

  1. Clone DIBgram repository

    git clone github.com/DIBgram/DIBgram.git
cd DIBgram

  2. Obtain API ID and API hash, and create config.js

  3. Install all dependencies

    npm install

  4. Build

    npm run build