Hackathon Open Platform - Web App

Open-source Hackathon Platform with Git-based Cloud Development Environment

Key links

• Task kanban
• UI design
• Web entry
  • testing: https://test.hackathon.fcc-cd.dev/
  • production: https://hackathon.fcc-cd.dev/
• RESTful API
  • production: https://openhackathon-service.onrender.com/

Technology stack

• Language: TypeScript v5
• Component engine: Next.js v16
• Component suite: Bootstrap v5
• State management: MobX v6
• PWA framework: Workbox v6
• CI / CD: GitHub Actions + Vercel

Environment Configuration

Configure the following required variables in your local environment:

# GitHub OAuth (required for login)
GITHUB_OAUTH_CLIENT_ID=your_client_id
GITHUB_OAUTH_CLIENT_SECRET=your_client_secret

# JWT Secret (required for session)
JWT_SECRET=your_jwt_secret

# API Host
NEXT_PUBLIC_API_HOST=https://openhackathon-service.onrender.com

Creating GitHub OAuth App

1. Go to GitHub Developer Settings
2. Click "New OAuth App"
3. Fill in:
   • Application name: HOP Local Dev
   • Homepage URL: http://localhost:3000
   • Authorization callback URL: http://localhost:3000
4. Copy the Client ID and generate a Client Secret

Getting Started

First, run the development server:

npm i
npm run dev
# or
npm i pnpm -g
pnpm i
pnpm dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.