SrcGallery Docs

Appearance

Development ​

Local Development Setup ​

If you want to run the project locally:

Prerequisites ​

  • Node.js (recommended: latest LTS version)
  • Git

Installation Steps ​

  1. Clone the repo:

    bash
    git clone https://github.com/ProjectDepot/SrcGallery
cd SrcGallery

  2. Set up environment variables:

    • Copy .env.example to .env
    • Set your GitHub username: VITE_GITHUB_ACTOR=your_username

    Note

    When deployed via GitHub Actions, the workflow handles this configuration automatically.

  3. Install dependencies:

    bash
    npm install

  4. Fetch initial data for your GitHub profile:

    bash
    npm run fetch-data

  5. Start the development server:

    bash
    npm run dev

The application will be available at http://localhost:4321.

Available Scripts ​

  • npm run dev - Start the development server
  • npm run build - Build the project for production
  • npm run preview - Preview the production build locally
  • npm run fetch-data - Fetch GitHub repository data
  • npm run lint - Run ESLint
  • npm run docs:dev - Start the documentation server
  • npm run docs:build - Build the documentation
  • npm run docs:preview - Preview the documentation build

Project Structure ​

text
├── .github/workflows/      # GitHub Actions workflows
├── docs/                   # Documentation (VitePress)
├── public/                # Static assets
├── scripts/                # Build and data fetching scripts
├── src/                    # Main application source
│   ├── components/         # Vue components
│   ├── content/projects/   # Project pages (markdown files)
│   ├── pages/              # Astro pages
│   ├── types/              # TypeScript type definitions
│   ├── App.vue             # Vue main page entry point
│   ├── main.ts             # Vue main page entry point script
│   └── utils.ts            # Utility functions
├── astro.config.mjs       # Astro configuration
├── src/config.ts          # Main configuration
└── src/config.user.ts     # User configuration override

Contributing ​

Contributions are welcome! Please feel free to submit a Pull Request.

License ​

This project is licensed under the MIT License.