https://github.com/negrel/scratch
A tool to quickly scratch project in your favorite language.
https://github.com/negrel/scratch
Last synced: 3 months ago
JSON representation
A tool to quickly scratch project in your favorite language.
- Host: GitHub
- URL: https://github.com/negrel/scratch
- Owner: negrel
- Created: 2023-05-03T18:48:43.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-30T15:07:10.000Z (10 months ago)
- Last Synced: 2025-01-08T09:13:57.602Z (5 months ago)
- Language: Shell
- Size: 25.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# `scratch` - Quickly scratch project in your favorite language.
## Getting started
You must have [Nix](https://nixos.org/download.html) package manager installed and enable experimental support of `nix-command` and `flakes`.
This tool is based on [flakes registries](https://nixos.org/manual/nix/unstable/command-ref/new-cli/nix3-registry.html) and
[flakes templates](https://nixos.org/manual/nix/unstable/command-ref/new-cli/nix3-flake-init.html#template-definitions).
You can configure your own template registry with:
```shell
# Add your registry.
nix registry add templates github:/
# Update your registry.
nix flake update templates
```
> **NOTE**: You can use [my repository](https://github.com/negrel/templates) as a starting point.
## Create a project from a template
```shell
# Create a new project under "/tmp/scratch-rust-project" using the "rust" template.
scratch rust /tmp/scratch-rust-project
# Print help menu
scratch --help
```
## Contributing
If you want to contribute to `scratch` to add a feature or improve the code contact me at [[email protected]](mailto:[email protected]), open an [issue](https://github.com/negrel/scratch/issues) or make a [pull request](https://github.com/negrel/scratch/pulls).
## :stars: Show your support
Please give a :star: if this project helped you!
[](https://www.buymeacoffee.com/negrel)
## :scroll: License
MIT © [Alexandre Negrel](https://www.negrel.dev/)