Skip to content

ayushch80/OutRun

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

7 Commits
Β 
Β 
Β 
Β 

Repository files navigation

OutRun πŸš€πŸš€πŸš€

OutRun is a lightweight project initialization tool designed to streamline setting up new projects with essential configurations. 🎯✨πŸ”₯

Features ⚑

  • 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

Installation πŸ› οΈ

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

Usage πŸƒβ€β™‚οΈ

Run the script with the following commands:

./src/outrun.sh <command> [options]

Available Commands 🎯

  • help - Show available commands
  • version - Display the current OutRun version
  • init [path] - Initialize an OutRun project (default: current directory)

Example Usage πŸ—οΈ

./src/outrun.sh init my-project

Configuration βš™οΈ

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"

License πŸ“„

This project is licensed under the MIT License.

Contributing 🀝

Feel free to fork the repository, create a new branch, and submit a pull request! 🎨

About

Instantly host a Next.js site via Cloudflare Tunnel. No ports, no hassle. πŸš€

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages