Skip to content
View gasu04's full-sized avatar
:atom:
:atom:

Block or report gasu04

Block user

Prevent this user from interacting with your repositories and sending you notifications. Learn more about blocking users.

You must be logged in to block users.

Content in all repositories owned by your account will be closed.
Maximum 250 characters. Please don’t include any personal information such as legal names or email addresses. This note will only be visible to you.
Report abuse

Contact GitHub support about this user’s behavior. Learn more about reporting abuse.

Report abuse
gasu04/README.md

[Project Name]

Personal site and workspace for developing internal apps for personal use. The repository hosts the public GitHub Pages site at [site URL] and the code for private tools built alongside it.

Purpose

  • Publish the public site: landing page, Privacy Policy, and Terms of Service.
  • Develop small internal apps and utilities for personal use. These are not intended for public distribution.

Repository layout

.
├── index.html            # Public landing page
├── privacy-policy.html   # Public privacy policy
├── terms-of-service.html # Public terms of service
├── apps/                 # Internal apps, one folder per app
│   └── <app-name>/
├── shared/               # Code reused across apps (helpers, styles)
├── scripts/              # Build, deploy, and maintenance scripts
├── .env.example          # Template for required environment variables
└── README.md

Adjust this layout as the project grows. Keep public and internal code clearly separated.

Getting started

Requirements:

  • [Runtime, e.g., Node.js 20+ or Python 3.12+]
  • Git
  • [Other tools, e.g., Docker, a database client]

Setup:

git clone [repository URL]
cd [project folder]
cp .env.example .env   # then fill in the values
[install command]      # e.g., npm install or pip install -r requirements.txt

Running an app locally

cd apps/<app-name>
[run command]          # e.g., npm run dev or python app.py

Environment variables

Secrets and personal data never go in version control. Put them in .env, which is git-ignored, and document each variable in .env.example with a placeholder value.

Variable Used by Description
[VARIABLE_NAME] [app] [What it configures]

Deployment

The public site deploys from the [main / gh-pages] branch through GitHub Pages. Each push updates [site URL] within a few minutes.

Internal apps are not deployed publicly. Run them locally or on a private host reachable only over a trusted network.

Conventions

  • One folder per app under apps/, each with its own README describing its purpose and how to run it.
  • Keep dependencies minimal. Record them in the app's own manifest.
  • Commit .env.example but never .env.
  • Never commit credentials, API keys, personal data, or private documents. If something sensitive is committed by mistake, rotate the credential immediately and rewrite the history.
  • Write commit messages in the imperative mood, for example "Add expense export to finance app".

Security notes

  • Internal apps may hold personal data. Keep their data files out of the repository.
  • Keep the GitHub repository private if it contains anything beyond the public site.
  • Review the public pages before each deploy so that no internal details leak into them.

Roadmap

  • [First internal app or utility]
  • [Next item]

License

Public site content: [license, e.g., All rights reserved, or CC BY 4.0]. Internal apps: private, not licensed for redistribution.

Popular repositories Loading

  1. claude-code claude-code Public

    Claude Code CLI

    JavaScript 1

  2. UBIKParallax UBIKParallax Public

    Observations registered from outside the system — all temporal intervals accessible, none ranked, none sequential.

    TypeScript 1

  3. panacompra panacompra Public

    scraper and parser

    HTML 2

  4. helloworld helloworld Public

    Jupyter Notebook

  5. ProjectEuler ProjectEuler Public

  6. pinecone pinecone Public