https://github.com/noclocks/template-client-repo
Template Client Repository
https://github.com/noclocks/template-client-repo
Last synced: 4 months ago
JSON representation
Template Client Repository
- Host: GitHub
- URL: https://github.com/noclocks/template-client-repo
- Owner: noclocks
- License: unlicense
- Created: 2024-05-21T22:32:09.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-21T15:35:17.000Z (6 months ago)
- Last Synced: 2025-06-10T11:41:29.092Z (5 months ago)
- Size: 43.9 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - noclocks/template-client-repo - Template Client Repository (Others)
README
# Template Client Repository
> [!NOTE]
> This is a template repository for a high-level *client repository* meant to store all client-related files and assets as well as any potential
> projects and/or source code in the form of a git-submoduled mono-repo.
> [!WARNING]
> This repository is meant to be used as a template for creating a new client repository and should not be used as a client repository itself.
***
## Structure
Below is an example repository structure for a client:
```plaintext
client-acme/
├── .github/ # GitHub Configuration, Copilot Instructions, and Workflows
├── admin/ # -> Linked to Google Drive Administrative Folder
├── brand/ # Symlinks to Drive Brand Assets
├── config/ # Client Configs; Infrastructure-as-Code (Terraform/GCP)
├── data/ # Processed Client Data (Raw in Google Drive)
├── docs/ # Technical Documentation (API specs, etc.)
└── src/ # Source Code / Git Modules to Client Repos
```
## Folders
- [admin/](admin/): Administrative Files
- [brand/](brand/): Client Brand Assets
- [config/](config/): Configuration Files
- [data/](data/): Data Files
- [docs/](docs/): Documentation
- [src/](src/): Client Project Source Code
- [tools/](tools/): Tools
plus,
- [.github/](.github/): GitHub Configuration Files
- [.vscode/](.vscode/): VSCode Configuration Files
## Usage
`#TODO`