Skip to content

GraphicsProgrammingKnights/gpkweb

Repository files navigation

Graphics Programming Knights Web Dev Repo

GPK Banner

Team

Lead

Admins

Dev Team

Tech Stack

  • Next.js
  • React Three Fiber (R3F) + Drei
  • Tailwind CSS
  • TypeScript
  • ESLint
  • Node.js (LTS)

Quick Start

git clone https://github.com/GraphicsProgrammingKnights/gpkweb
cd gpkweb
npm install
npm run dev

Open http://localhost:3000.

For full setup details (Node version pinning, lint, build, Docker), the PR workflow, branch/commit conventions, and a command cheat sheet, see CONTRIBUTING.md.

Project Structure

.
├── 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
├── CONTRIBUTING.md        # Contributor guide
├── tsconfig.json          # TypeScript configuration
├── package.json
└── README.md

Infrastructure

GitHub Actions workflows run automatically on PRs and pushes to main:

Workflow Trigger What it does
CI PRs and pushes to main Runs lint and build
Docker Build PRs/pushes affecting app code or Docker files Verifies Docker image builds

View workflow runs: Actions tab.

Contributing

See CONTRIBUTING.md for the full contributor guide — setup, PR workflow, branch/commit conventions, Docker commands, and a "what to do / not to do" reference.

License

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

About

Website for Graphics Programming Knights @ UCF

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors