🚀 Getting Started

This guide will walk you through setting up gh.gg for local development. Follow these steps to get your environment ready and the application running.

Prerequisites

Before you begin, ensure you have the following installed:

• Bun↗ (recommended) or Node.js 18+
• Docker↗ (for running the local PostgreSQL database)
• GitHub OAuth App credentials (you'll configure this in a later step)

One-Command Setup

The easiest way to get started is by using the automated setup script.

1. Clone the repository:

2. Run the automated setup script:
   This command will perform several actions:
   • ✅ Install all project dependencies.
   • ✅ Create a .env.local configuration file.
   • ✅ Start a PostgreSQL database using Docker.
   • ✅ Run all necessary database migrations.

Configure GitHub OAuth

To allow users to sign in with GitHub, you need to set up a GitHub OAuth App and provide its credentials to your local environment.

1. Go to GitHub Developer Settings↗.
2. Click "New OAuth App".
3. Fill in the application details:
   • Application name: gh.gg-dev (or any name you prefer for local development)
   • Homepage URL: http://localhost:3000
   • Authorization callback URL: http://localhost:3000/api/auth/callback/github
4. After creating the app, copy the generated Client ID and Client Secret.
5. Open your .env.local file (created by bun run setup) and update the following variables with your copied credentials:

Start Development

Once the setup is complete and GitHub OAuth is configured, you can start the development server.

1. Run the development command:

2. Open your browser and navigate to http://localhost:3000↗. 🎉

You're now ready to explore and develop gh.gg!