Skip to content

aryan02420/wordle

Repository files navigation

WORDLE

Installation

Requires node>=16

CLI

Play without installing

npx @aryan02420/wordle

Install globally

npm i -g @aryan02420/wordle
wordle
Install locally (not recommended)
npm i @aryan02420/wordle
./node_modules/.bin/wordle

preview

GitHub Actions

  • Create <user>/<repo>/.github/workflows/wreadle.yml

    name: 'Wreadle'
    
    on:
      repository_dispatch:
        # change this
        types: [my-event-name]
    
    jobs:
      wordle:
        runs-on: ubuntu-latest
        steps:
          - name: Cancel Previous Runs
            uses: styfle/[email protected]
            with:
              # automatically generated by github
              access_token: ${{ github.token }}
    
          - name: Checkout
            uses: actions/checkout@v3
    
          - name: Wreadle
            uses: aryan02420/[email protected]
            id: wreadle
            with:
              # path to your readme file relative to root
              readme: ./README.md
              # tag used to identify wreadle section
              tag: wreadle
              # url of the server authorized to create dispatch event
              serverUrl: https://myserver.com/dispatch
    
          - name: commit
            run: |
              git config --local user.name 'github-actions[bot]'
              git config --local user.email 'github-actions[bot]@users.noreply.github.com'
              git commit -am '🐛 Wordle update!' | true
              git push
    
  • Update readme. wreadle is the tag from above.

    <!--START_SECTION:wreadle-->
    <!--END_SECTION:wreadle-->
  • Go to <serverUrl>/<user>/<repo>/my-event-name/new to generate a new game

Server

Hosting locally

  • Create a .env file.

    cp .env.example .env
  • Create a new Personal Access Token with the repo scope. Update the .env file with this token. Click the link below to create a new PAT.

    https://github.com/settings/tokens/new?scopes=repo

  • Run the server

    npm run dev:start

NOTE: if using this hosting method, serverUrl in github workflow file should be <myserver.com>/dispatch

Hosting on a server

  • Set the environment variables listed in .env.example file

  • Run the server script

    npm run start

Hosting on deno deploy

  • Create a new empty project

    https://dash.deno.com/new    >    + Empty Poject

  • Create a deployment using deployctl

    deployctl deploy --project=<myproject> --no-static https://raw.githubusercontent.com/aryan02420/wordle/main/deno/index.ts
  • Set the GITHUB_TOKEN environment variable

NOTE: if using this hosting method, serverUrl in github workflow file should be myproject.deno.dev

Github App

TODO