Skip to content

resources2/shsf-web

 
 

Repository files navigation

SHSF Work Website

Frontend repository for the SHSF work website built with Next.js, TypeScript, and Tailwind CSS.

Getting Started

Prerequisites

  • Node.js (LTS version recommended)
  • npm or bun

Installation

  1. Clone the repository
git clone https://github.com/your-org/shsf-web.git
cd shsf-web
  1. Install dependencies
npm install
# or
bun install
  1. Set up environment variables
cp env.local.example .env.local

Edit .env.local with your configuration values.

  1. Start the development server
npm run dev
# or
bun dev

The site will be available at http://localhost:3000.

Environment Variables

Variable Description
USE_MOCK_DATA_FOR_DEVELOPMENT Set to true to use mock data in development
GITHUB_APP_ID Your GitHub App ID
GITHUB_PRIVATE_KEY Your GitHub App private key
GITHUB_INSTALLATION_ID Your GitHub App installation ID

Build and Deployment

# Run production build
npm run build
# or
bun build

# Start production server
npm run start
# or
bun start

Technology Stack

Project Structure

Project Structure
├── app/
├── assets/           # Assets, resources, and styles
├── components/
├── constants/        # Constants and configuration
├── hooks/
├── layouts/          # Page layouts and structural templates
├── lib/
├── modules/          # Feature-specific page implementations
├── providers/        # Context providers
├── public/
├── services/         # API services and external integrations
├── types/
└── www/              # Content collections

Development

Linting

npm run lint
# or
bun lint

License

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

Contributing

Please read our Code of Conduct before contributing to this project.

About

SHSF Work Website Source Code

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 83.7%
  • MDX 14.1%
  • CSS 2.0%
  • JavaScript 0.2%