deepaks-github / cloudshell

CloudShell is a web-based terminal application built with Node.js. It enables you to execute shell commands from a web interface, supporting interactive shell access and real-time command execution. Easily deploy using Docker or set up manually.

CloudShell

CloudShell is a web-based terminal application built with Node.js and React.js. It allows you to execute shell commands from a web interface. The project is designed to be simple and easy to set up, with options for running in a Docker container using Docker Compose or manually.

Features

• Interactive shell access through a web browser
• Supports Bash and other shell environments
• Real-time command execution and output display

Architecture Overview

Screenshots

Getting Started

Prerequisites

• Node.js
• Docker and Docker Compose (optional, for Docker installation)

Installation

Docker Compose Installation (may take some time)

1. Clone the repository

   git clone https://github.com/DeepakS-Github/CloudShell
   cd CloudShell

2. Build and start the Docker containers

   docker-compose up --build

3. Access the web terminal

   Open your browser and navigate to http://localhost:3000.

Note: When you run the project in the Docker environment using Docker Compose, the server will run in an Ubuntu container which is independent from your computer environment.

Manual Installation

1. Clone the repository

   git clone https://github.com/DeepakS-Github/CloudShell
   cd CloudShell

2. Install server dependencies

   cd server
   npm install

3. Install client dependencies

   cd ../client
   npm install

4. Build the client

   npm run dev

5. Start the server

   cd ../server
   npm start

6. Access the web terminal

   Open your browser and navigate to http://localhost:3000.

Note: When you use the manual installation and run the code, the shell will be linked to your computer's environment.

Usage

• Open the web terminal in your browser.
• Type your commands and see the output in real time.

If you find this project helpful, we'd appreciate it if you could give it a star ⭐.