SafeExec is an enterprise-grade, open-source Remote Code Execution (RCE) platform that enables secure, isolated execution of code in multiple programming languages. Built with security-first architecture, it provides Docker-containerized execution environments, JWT authentication, comprehensive rate limiting, and real-time monitoring.
- Security First: Every code execution runs in isolated Docker containers
- Open Source: Community-driven development and contributions welcome
- Easy Setup: One-command Docker deployment for all environments
- Well Documented: Comprehensive API docs and contributor guides
- Beautiful API Docs: Industrial-level Swagger UI with interactive examples
- Hot Reload: Docker development environment with automatic code reloading
- Multi-Language: Python, JavaScript, Java, C++, C#, Go support
- Queue System: Redis-powered job queue for scalable execution
- Node.js 18+ and Yarn package manager
- Docker & Docker Compose (latest versions)
- Git for version control
- MongoDB (handled by Docker Compose)
- Redis (handled by Docker Compose)
We love contributors!
Follow these steps to get started quickly as a contributor:
# Fork the repository on GitHub first, then: git clone https://github.com/YOUR_USERNAME/SafeExec.git cd SafeExec # Add upstream remote for syncing git remote add upstream https://github.com/vikashkrdeveloper/SafeExec.git# Copy environment template - MUST DO THIS FIRST cp .env.example .env # Edit the .env file with your local configuration nano .env # or use your preferred editorSample .env for local development:
# Environment ENV=development NODE_ENV=development PORT=5000 # MongoDB (use localhost for local development & MongoDB Compass) MONGO_USERNAME=admin MONGO_PASSWORD=devpassword MONGO_DB=safeexec_dev MONGODB_URI=mongodb://admin:devpassword@localhost:27017/safeexec_dev?authSource=admin # Redis (use localhost for local development & Redis clients) REDIS_URI=redis://localhost:6379 # Security JWT_SECRET=your-super-secret-jwt-key-for-development JWT_EXPIRES_IN=24h # CORS ALLOWED_ORIGINS=http://localhost:3000,http://localhost:3001# Complete development setup in one command yarn setup:dev # This command will: # - Install all dependencies # - Build Docker executor containers # - Start development environment with Docker Compose # - Mount source code for hot-reload (changes auto-reload containers) # - Seed database with sample data # - Start both API server and worker with live reloading🔥 Hot-Reload Feature: Code changes automatically reload containers without rebuilding! Your changes in VS Code are instantly reflected in the running Docker containers.
yarn setup # Equivalent to: yarn install && yarn build:executors # Start all services: API, MongoDB, Redis, Nginx yarn docker:setup:dev # Or start services individually yarn docker:dev:build # Build containers yarn docker:dev # Start all services yarn docker:seed:dev # Seed database with sample data yarn dev # API only (requires local MongoDB/Redis)# Check all services are running yarn docker:status # Check API health yarn health # Or manually: curl -f http://localhost:5000/health # View logs yarn logs # Or: yarn docker:dev:logs # Access container shell (for debugging) yarn shell # Or: yarn docker:dev:shell# 1. Sync with upstream git checkout master git pull upstream master git push origin master # 2. Create feature branch git checkout -b feature/your-feature-name # 3. Start development environment yarn setup:dev # Or if already set up: yarn docker:dev # 4. Make your changes... # 5. Run tests and checks yarn test yarn lint yarn typecheck # 6. Test in different environments yarn docker:test:run # Run tests in test environment yarn docker:test:coverage # Generate coverage report # 7. Commit and push git add . git commit -m "feat: your descriptive commit message" git push origin feature/your-feature-name # 8. Create Pull Request on GitHub# Run all tests yarn test # Run tests with coverage yarn test:coverage # Run integration tests yarn test:integration # Test Docker containers yarn docker:test # Start test environment yarn docker:test:run # Run tests in containers yarn docker:test:coverage # Generate coverage in containers # Manual API testing yarn health # Check API health curl http://localhost:5000/api-docs # Check API docs# View logs yarn logs # Development logs yarn docker:dev:logs # Development logs # Access container shell yarn shell # Development container yarn docker:dev:shell # Development container # Check service status yarn docker:status # All containers status yarn docker:health # Health check status # Restart services yarn restart # Restart development environment yarn reset # Complete reset (clean + setup)Docker Permission Errors (EACCES /var/run/docker.sock):
# Quick fix - Run the permission fix script yarn fix:docker # Manual fixes sudo usermod -aG docker $USER # Add user to docker group sudo chmod 666 /var/run/docker.sock # Set socket permissions newgrp docker # Apply group changesDocker Service Issues:
sudo systemctl start docker # Start Docker service sudo systemctl restart docker # Restart Docker service sudo systemctl status docker # Check Docker statusContainer Build Failures:
yarn docker:clean # Clean Docker system yarn docker:clean:all # Complete Docker cleanup yarn build:executors # Rebuild executor imagesWe welcome contributions from developers of all skill levels! Whether you're fixing bugs, adding features, improving documentation, or enhancing security, your contributions help make this project better for everyone.
- Find an issue: Look for good first issue or help wanted
- Discuss: Comment on issues or open a new one for ideas
- Follow code style: Use ESLint, Prettier, and TypeScript
- Write tests: Keep coverage high
- Update docs: If you change or add features
See the Contributing Guide for more details.
Note: This project is open source and intended for local development, testing, and educational use. For production deployment, please refer to the DEPLOYMENT.md guide and follow security best practices. Production-specific instructions have been removed from this README.
For production security, see DEPLOYMENT.md and DOCKER.md.
Your contributions help create a better, more secure code execution platform for developers worldwide.
MIT License - see LICENSE file for details
For issues and questions:
- Create GitHub issues for bugs
- Check documentation for common solutions
- Review logs for detailed error information
- Test with provided test scripts