• Sebastian Noel (@sebastian-noel)
• Stevin George (@stevin006)
• Alejandro Jaimes (@alecocosette)

Message Sebastian through discord if you have an interest in contributing.

• Next.js
• Three.js
• TypeScript
• ESLint
• Node.js (LTS)

git clone https://github.com/GraphicsProgrammingKnights/gpkweb

cd gpkweb

• Node.js 20+ (LTS recommended)
• npm

Use the following commands to ensure you are using Node.js 20 specified in .nvmrc

nvm install  # Install
nvm use      # Switch to version

npm install

npm run dev

Open http://localhost:3000

npm run lint

npm run build
npm run start

• main is protected and always stable.

• Create branches from main:

  git checkout -b <branch-type>/<short-description>

  Examples:

  • feature/about-section
  • fix/mobile-view-bug
  • chore/docker-setup

• Open a Pull Request into main.

• GitHub Actions CI/CD runs and must pass checks.

• At least 1 teammate review required before merge.

• Use squash merge to main for clean history.

Follow this commit style (examples provided):

• feat: add hero section
• fix: correct navbar mobile layout
• chore: update dependencies
• docs: improve setup instructions

.
├── app/                   # Next.js routes
├── components/            # Reusable UI components
├── public/                # Static assets
├── styles/                # Global/component styles
├── .github/               # GitHub templates/workflows
│   └── workflows/         # CI/CD pipelines
├── Dockerfile             # Production container
├── docker-compose.yml     # Local Docker setup
├── .dockerignore          # Docker build exclusions
├── tsconfig.json          # TypeScript configuration
├── package.json
└── README.md

• Docker installed
• Docker Compose (included with Docker Desktop)

# Build and start the container
docker compose up --build

# Run in background
docker compose up -d --build

# Stop the container
docker compose down

# Build the image
docker build -t gpkweb .

# Run the container
docker run -p 3000:3000 gpkweb

Open http://localhost:3000

GitHub Actions workflows run automatically:

View workflow runs: Actions tab

This project is licensed under the MIT License - see the LICENSE file for details.