Setup Local Development

This guide will walk you through setting up a local development environment for the Blog HIMARPL website.

Prerequisites

Before installing the application, ensure you have:

Node.js and npm installed
Git installed
Access to the following services:
- CockroachDB account
- Google OAuth credentials
- Upstash account
- PostHog account (optional)

Environment Setup Details

The project requires several environment variables to be set up in a .env file for proper functionality:

Required Services Setup

CockroachDB Setup
- Follow the CockroachDB Quickstart Guide to get your DATABASE_URL
Google OAuth Setup
- Follow Google OAuth Guide to get:
  - GOOGLE_CLIENT_ID
  - GOOGLE_CLIENT_SECRET
Upstash Rate Limiting Setup
- Follow Upstash Ratelimiting Guide to get:
  - UPSTASH_REDIS_REST_URL
  - UPSTASH_REDIS_REST_TOKEN
Bot API Setup (optional)
- Follow Bot API Guide to get:
  - BOT_API_URL
  - BOT_API_TOKEN

Setup Steps

Fork and clone the repository:

git clone https://github.com/himarplupi/blog-himarpl.git

git clone git@github.com:himarplupi/blog-himarpl.git

gh repo clone himarplupi/blog-himarpl

Navigate to project directory:
Terminal window
```
cd blog-himarpl
```

Create environment variables file: Create a .env file in the root directory with the following variables:

NEXT_PUBLIC_BASE_URL="http://localhost:3000"
NEXT_PUBLIC_BASE_PATH=""
NEXT_BASE_URL="http://localhost:3000"

# Database
DATABASE_URL=

# Authentication
NEXTAUTH_SECRET=
NEXTAUTH_URL="http://localhost:3000"
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=

# Rate Limiting
UPSTASH_REDIS_REST_URL=
UPSTASH_REDIS_REST_TOKEN=

# PostHog (optional)
NEXT_PUBLIC_POSTHOG_KEY=
NEXT_PUBLIC_POSTHOG_HOST=https://us.i.posthog.com

# Bot API (optional)
BOT_API_URL=
BOT_API_TOKEN=

Set up remote upstream:

git remote add upstream https://github.com/himarplupi/blog-himarpl.git

git remote add upstream git@github.com:himarplupi/blog-himarpl.git

gh repo sync himarplupi/blog-himarpl

Install dependencies and start development server:

npm ci              # Install dependencies
npm run db:push     # Push database schema to CockroachDB
npm run dev         # Start development server

The application should now be running at http://localhost:3000.

Create a new branch for your changes:
Terminal window
```
git checkout -b my-feature-branch
```
After you are satisfied with your changes, add and commit them to your branch, then push your branch to your fork.
Terminal window
```
git add .
git commit # Please follow the commit guidelines below
git push -u origin my-feature-branch
```
Before committing and opening a Pull Request, please read Commit Guidelines and Pull Request Policy below.
Create Pull Request.

We request PR authors to avoid rebasing/updating their PRs with the main branch unnecessarily.

Available Scripts

npm run dev - Starts development server with Turbo
npm run build - Creates production build
npm run start - Starts production server
npm run db:push - Pushes database schema to CockroachDB
npm run db:studio - Opens Prisma Studio for database management
npm run lint - Runs linting checks
npm run test - Runs Jest tests
npm run test:watch - Runs Jest tests in watch mode