warp-alternative

GitHub Stars GitHub Forks GitHub Issues GitHub PRs
๐ŸŒ This project is community-driven! Fork, contribute, and help us build the future of open source terminals.

Key Features

๐Ÿš€ Getting Started

๐Ÿ“ฆ Installation

# Clone the repository
git clone https://github.com/cadot-eu/warp-alternative.git
cd warp-alternative

# Install dependencies
npm install

โš™๏ธ Configuration

Copy the example environment file and configure your API keys:

cp .env.example .env.local
# Edit .env.local with your credentials

๐Ÿ› ๏ธ Development Mode

Start the development environment with hot reloading:

# Start Next.js dev server
npm run dev

# In another terminal, start WebSocket server
npm run terminal-server

Access the application at http://localhost:3000

๐Ÿญ Production Mode

Build and run the optimized production version:

# Build the application
npm run build

# Start production server
npm start

# Don't forget the terminal server
npm run terminal-server

๐Ÿงช Testing

warp-alternative includes comprehensive testing with Jest. Run tests to ensure everything works correctly:

Basic Testing

# Run all tests
npm test

# Run tests with coverage report
npm run test:coverage

Development Testing

# Run tests in watch mode
npm run test:watch

# Lint the codebase
npm run lint
โš ๏ธ Important: Make sure both the Next.js server and the WebSocket terminal server are running for full functionality.

How to Contribute

๐Ÿš€ Join us and make warp-alternative the best open source terminal for everyone!

Contact & Community

Open an issue or contact the maintainer for questions or suggestions.
GitHub Issues