Gumboard

Keep on top of your team's to-dos.

Getting Started

Prerequisites

• Docker Compose
• Node

Install dependencies

npm install

Database Setup

1. Create your environment variables file:

cp .env.example .env

2. Start the PostgreSQL database using Docker:

npm run docker:up

3. Push the database schema:

npm run db:push

Development Server

First, run the development server:

npm run dev

Visit http://localhost:3000 in your browser to access the application.

Database Commands

• npm run docker:up - Start PostgreSQL database
• npm run docker:down - Stop PostgreSQL database
• npm run db:generate - Generate Prisma client
• npm run db:push - Push schema changes to database
• npm run db:migrate - Run database migrations
• npm run db:studio - Open Prisma Studio (database GUI)
• npm run db:reset - Reset database and run migrations

Schema Changes

When changing the database schema in prisma/schema.prisma, create and check in a new migration to apply the changes in production:

npm run db:migrate

🔐 Google OAuth Setup

To enable login with Google, follow these steps:

1. Create Google OAuth Credentials

1. Visit Google Cloud Console.
2. Navigate to:
   APIs & Services → Credentials → Create Credentials → OAuth Client ID
3. Choose Web Application as the application type.
4. Add this to Authorized redirect URIs:

   http://localhost:3000/api/auth/callback/google
   

   (Replace with your production URL if deploying)

---

2. Add Environment Variables

In your .env.local file, add:

GOOGLE_CLIENT_ID=your-client-id
GOOGLE_CLIENT_SECRET=your-client-secret

🔐 GitHub OAuth Setup

To enable login with GitHub, follow these steps:

1. Create GitHub OAuth App

1. Go to GitHub Developer Settings
2. Click OAuth Apps → New OAuth App
3. Fill in the application details:
   • Application name: Gumboard (or your preferred name)
   • Homepage URL: http://localhost:3000 (for development)
   • Authorization callback URL: http://localhost:3000/api/auth/callback/github
4. Click Register application
5. Copy the Client ID and Client Secret

2. Add Environment Variables

In your .env.local file, add:

GITHUB_CLIENT_ID=your_github_client_id
GITHUB_CLIENT_SECRET=your_github_client_secret