Table of Contents

• Table of Contents
  • Overview
    • Local setup
      • Cloning repository
      • Running the website
    • Deployment
    • Author

Overview

This repository houses the lurkr.gg website, which is the website for the Lurkr Discord bot.

Local setup

This setup assumes you have Git, and Node.js setup on your machine. This repository requires Node.js version 20 or higher, and uses the pnpm package manager, so you should have basic knowledge about how to use them.

Cloning repository

• git clone [email protected]:almeidx/lurkr-website.git
• cd lurkr-website
• pnpm i

Note: If you don't have corepack enabled, you can do it with corepack enable.

Running the website

• pnpm dev

Note: Most features of the website requires an API instance running, which is currently not publicly available.

Deployment

The deployment of the website is all automated by Vercel

Author

lurkr-website © almeidx, released under the GNU AGPLv3 license.

GitHub @almeidx