Victor Leyva
🚀 zrpc - A Simple Way to Build APIs
🔗 Download Now
📖 Table of Contents
💡 What is zrpc?
zrpc is a modern framework that helps you create Remote Procedure Calls (RPC) in Elixir. With its simple Domain Specific Language (DSL), middleware support, and structured routing, you can define your API once. This makes it easy to automatically generate TypeScript clients and OpenAPI specifications. It’s designed for efficiency, helping you focus more on building your application rather than the underlying technology.
🚀 Getting Started
To get started with zrpc, follow these easy steps to set it up on your computer. You do not need to have programming skills for this process.
- Verify System Requirements
- Operating System: Windows, macOS, or Linux.
- Elixir version: Ensure you have Elixir installed on your machine.
- Sufficient disk space to install the application.
- Install Elixir
- Windows Users: Download and install from the official Elixir website.
- macOS Users: Use Homebrew. Open your terminal and type:
brew install elixir - Linux Users: Use your package manager. For Ubuntu, use:
sudo apt-get install elixir
- Download zrpc
- Visit the Releases page to find the latest version.
- Choose the file appropriate for your system.
💾 Download & Install
To download zrpc, visit the following link: Download zrpc. Once on the release page, select the package for your operating system and download it.
- Extract Files
- After downloading, locate your downloaded file and extract it. On Windows, right-click the file and choose “Extract All.” On macOS, double-click the file to extract it. For Linux, use:
tar -xvzf your_downloaded_file.tar.gz
- After downloading, locate your downloaded file and extract it. On Windows, right-click the file and choose “Extract All.” On macOS, double-click the file to extract it. For Linux, use:
- Run zrpc
- Open your command line interface:
- Windows: Command Prompt or PowerShell.
- macOS and Linux: Terminal.
- Navigate to the folder where you extracted zrpc.
- Run the application using:
elixir -S mix run
- Open your command line interface:
- Follow the Setup Guide
- Once zrpc is running, follow the on-screen prompts to complete the setup.
🛠️ Features
- Clean DSL: Easily define APIs without complex syntax.
- Middleware System: Use middleware to handle requests and responses efficiently.
- Hierarchical Routing: Organize routes in a structured manner for better readability and manageability.
- Automatic Code Generation: Generate TypeScript clients and OpenAPI specifications from your API definitions.
- Wide Compatibility: Works with common operating systems like Windows, macOS, and Linux.
🤝 Support
If you encounter issues using zrpc or need assistance, you can reach out via the GitHub issues page of this repository. Community support is available, and you can also check documentation for more detailed instructions.
For further information, stay updated on new releases, tips, and common questions by following this repository. Your feedback is appreciated as we are continually working to improve the software.