![Logo](https://ftw.usatoday.com/wp-content/uploads/sites/90/2022/11/god-of-war-ragnarok-review-17-e1667913069690.jpg?w=1000&h=600&crop=1)
Lightweight Package Manager for NodeJs
Tyrr is a simple yet powerful package manager designed to streamline the management of dependencies and scaffolding for Node.js projects. Tyrr, written in Rust, aims to provide efficient and reliable functionality while simplifying the development process for Node.js projects.
Introduction
Tyr (referred to as 'Tyrr' in the npm ecosystem due to naming conflicts) offers a range of features to enhance your development workflow:
init
: Quickly scaffold a new Node.js project by generating apackage.json
file with essential project details. Tyrr prompts you for necessary information to get started.add
: Easily fetch packages from the NPM registry and update thetyr.lock
file to track package versions and dependencies.install
: Resolve dependencies listed in both thetyr.lock
file andpackage.json
file effortlessly.run
: Executes a script defined in thepackage.json
file. This facilitates running various tasks and scripts configured in thepackage.json
, such as starting a development server or running build processes.
Installation
Using npm
To begin using Tyrr, simply install it globally using npm:
npm install -g tyrr
Using npx
Alternatively, you can use npx
to run Tyrr without installing it globally:
npx tyrr <command>
Option 3:
![Logo](https://developer.okta.com/assets-jekyll/blog/programming-security-and-why-rust/safety-meme-de9d74df45fbcb3315af678a2cc84baac294ae29c186910b5173cd76f8ee8af8.jpg)
For developers who want to contribute or experiment with Tyrr's Rust codebase, follow these steps:
- Clone the Tyrr repository from GitHub:
git clone https://github.com/jkitsao/tyr.git
- Navigate into the cloned repository:
cd tyr
- Run Tyrr using Cargo:
cargo run -- <command>
Choose the option that best suits your needs to start using Tyrr and enhance your Node.js development workflow.
Commands
1. Init Command
The init
command is your gateway to quickly scaffolding a new Node.js project. It guides you through providing essential project details and generates a package.json
file accordingly.
Usage
tyrr init
Example Generated
{
"name": "my-awesome-project",
"version": "1.0.0",
"description": "An awesome Node.js project managed with Tyrr",
"main": "index.js",
"author": "Your Name",
"license": "MIT"
}
2. Add Command
The add
command allows you to fetch packages from the NPM registry and update the tyr.lock
file to manage package versions and dependencies efficiently.
Usage
tyrr add <package-name>
3. Install Command
The install
command resolves dependencies listed in both the tyr.lock
file and package.json
file, ensuring your project has all the necessary dependencies installed.
Usage
tyrr install
Example Usage
Let's walk through a typical workflow with Tyrr:
Scaffold a New Node.js Project
tyrr init
Add a Package from the NPM Registry
tyrr add react
Install Dependencies
tyrr install
Run Application
tyrr run dev
Configuration
Tyrr doesn't require any additional configuration files. It leverages the package.json
and tyr.lock
files to manage project dependencies seamlessly.
Contributing
Tyrr is an open-source project, and we welcome contributions from the community. If you encounter any bugs or have suggestions for improvements, please feel free to submit a pull request on the GitHub repository (opens in a new tab).
Feedback and Support
For feedback, suggestions, or support inquiries, don't hesitate to reach out to us via GitHub Issues or contact us via email at kitsaojackson22@gmail.com.
License
This project is licensed under the MIT License. See the LICENSE file for details.