Skip to content

Files

Latest commit

neelp03neelp03
Update README.md
Oct 27, 2024
f80177f · Oct 27, 2024

History

History
126 lines (86 loc) · 3.89 KB

README.md

File metadata and controls

126 lines (86 loc) · 3.89 KB

dark-envirox-banner

npm version License GitHub issues GitHub contributors GitHub stars

EnviroX

EnviroX is a CLI tool designed to automate the setup of development environments for various programming languages and frameworks. With a single command, EnviroX detects the necessary dependencies, installs them, and configures your environment to get you started quickly.

Table of Contents

Features

  • Automatic Detection: Identifies project types and required dependencies.
  • Dependency Installation: Installs packages using appropriate package managers.
  • Cross-Platform Support: Compatible with Linux, macOS, and Windows.
  • Easy-to-Use CLI: Simple commands with helpful options.
  • Extensible Design: Built to support new languages and tools in the future.

Installation

Prerequisites

Install via npm

Install EnviroX globally using npm:

npm install -g envirox

Install from Source (Alternative)

Clone the repository and install dependencies:

git clone https://github.com/neelp03/envirox.git
cd envirox
npm install

Install EnviroX globally from the source:

npm install -g .

Install via .tgz file

Please find the required file in the latest release tab and download it on your machine

npm install -g "path/to/tgz/file"

Usage

After installing, you can run EnviroX in your project directory:

envirox

EnviroX will automatically detect your project type and set up the necessary environment.

Options

  • --language=<language>: Set up a specific language environment (e.g., node, python, go).
  • --docker: (Coming soon) Set up a Docker environment.
  • --help, -h: Display help information.

Examples

# Set up a Node.js environment
envirox --language=node

# Set up a Python environment
envirox --language=python

# View available options
envirox --help

Supported Languages and Tools

  • Node.js: Detects package.json and installs dependencies using npm or yarn.
  • Python: Detects requirements.txt and installs dependencies using pip.
  • Go: Detects go.mod and sets up the Go environment.
  • Docker: (Coming soon) Detects Dockerfile and builds Docker images.

Contributing

Contributions are welcome! Please read our Contributing Guidelines before submitting a pull request.

  1. Fork the repository.
  2. Create a feature branch (git checkout -b feature/your-feature).
  3. Make your changes.
  4. Commit and push your changes (git push origin feature/your-feature).
  5. Create a pull request.

License

This project is licensed under the Apache-2.0 License - see the LICENSE file for details.

Support

If you encounter any issues or have questions, please open an issue on GitHub.