OutRun is a lightweight project initialization tool designed to streamline setting up new projects with essential configurations. π―β¨π₯
- Displays a unique ASCII art banner
- Provides a command-line interface with useful commands
- Checks for required system dependencies
- Supports project initialization with customizable settings
- Generates a structured
out.run
configuration file
Ensure you have the required dependencies installed:
sudo apt install cloudflared yq npm node -y
Then, clone the repository:
git clone <repo-url>
cd outrun
chmod +x src/outrun.sh
Run the script with the following commands:
./src/outrun.sh <command> [options]
help
- Show available commandsversion
- Display the current OutRun versioninit [path]
- Initialize an OutRun project (default: current directory)
./src/outrun.sh init my-project
The init
command generates an out.run
file with project settings:
OUTRUN_VERSION: "1.0.0"
proj: "my-project"
root: "./"
manager: "npm"
port: "3000"
cmd:
build: "npm run build"
start: "npm run start"
This project is licensed under the MIT License.
Feel free to fork the repository, create a new branch, and submit a pull request! π¨