Skip to content

Repository files navigation

name_placeholder

description_placeholder

License Docs Language Checks Release GitHub tag (latest by date) GitHub last commit

Feature Highlights

TODO

TODO

Status

TODO

Workspace Posture

  • apps/name_placeholder/ owns the default Rust CLI application package.
  • scripts/ owns repository-maintenance TypeScript programs that run directly on the pinned Node.js runtime.
  • packages/ is reserved for reusable shared packages across Rust, JavaScript/TypeScript, Python, Swift, or other language toolchains.
  • The root Cargo.toml is a Rust workspace manifest and owns shared metadata, profiles, and dependency versions.
  • The root package.json, package-lock.json, and tsconfig.json own the TypeScript script toolchain and its exact development dependencies.
  • openwiki/ is the authoritative repository knowledge and agent-routing surface.

Usage

Installation

Build from Source

# Clone the repository.
git clone https://github.com/hack-ink/name_placeholder
cd name_placeholder

# To install rustup on macOS and Unix without selecting a global default
# toolchain, run the following command. This repository's rust-toolchain.toml
# is authoritative for ordinary Rust commands.
#
# On Windows, download rustup-init.exe from `https://rustup.rs` and run it with
# `--default-toolchain none`; rust-toolchain.toml remains authoritative.
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --default-toolchain none

# Install the necessary dependencies. (Unix only)
# Using Ubuntu as an example, this really depends on your distribution.
sudo apt-get update
sudo apt-get install <DEPENDENCIES>

# Build the default Rust app, and the binary will be available at `target/release/name_placeholder`.
cargo build --release -p name_placeholder

# Install the default Rust app from the workspace.
cargo install --path apps/name_placeholder --force

# If you are a macOS user and want to have a `name_placeholder.app`, run the following command.
# Install `cargo-bundle` to pack the binary into an app.
cargo install cargo-bundle
# Pack the app, and the it will be available at `target/release/bundle/osx/name_placeholder.app`.
cd apps/name_placeholder
cargo bundle --release

Download Pre-built Binary

  • macOS
  • Windows
    • TODO
  • Unix
    • TODO

Configuration

TODO

TODO

Interaction

TODO

Update

TODO

Development

Install the exact TypeScript development graph without running package lifecycle scripts:

npm ci --ignore-scripts

List tracked template markers before adopting the template:

cargo make list-template-markers

Run the complete Rust, TypeScript, and TOML validation gate:

cargo make check

Architecture

This template starts as a workspace-first monorepo:

  • runnable products belong under apps/
  • repository-maintenance programs belong under scripts/
  • reusable packages belong under packages/
  • repository-native checks are exposed through Makefile.toml
  • durable architecture, runbook, and routing notes belong under openwiki/

Support Me

If you find this project helpful and would like to support its development, you can buy me a coffee!

Your support is greatly appreciated and motivates me to keep improving this project.

  • Fiat
  • Crypto
    • Bitcoin
      • bc1pedlrf67ss52md29qqkzr2avma6ghyrt4jx9ecp9457qsl75x247sqcp43c
    • Ethereum
      • 0x3e25247CfF03F99a7D83b28F207112234feE73a6
    • Polkadot
      • 156HGo9setPcU2qhFMVWLkcmtCEGySLwNqa3DaEiYSWtte4Y

Thank you for your support!

Appreciation

We would like to extend our heartfelt gratitude to the following projects and contributors:

  • The Rust community for their continuous support and development of the Rust ecosystem.

Additional Acknowledgements

  • TODO

License

Licensed under GPL-3.0-only.

About

A workspace-first, language-agnostic monorepo template with batteries-included tooling, CI, releases, and agent-ready documentation.

Topics

Resources

Stars

6 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages