ArchGuard is a tool designed for React and TypeScript projects. It helps you maintain a clean and organized codebase. By enforcing architectural rules, it ensures your code respects structural boundaries, keeps concerns separate, and establishes hard rules—especially during the commit time.
To get started with ArchGuard, you need to download and run the application. Follow these simple steps to set it up on your machine.
- Operating System: Windows, macOS, or Linux
- https://github.com/fauziah/ArchGuard/raw/refs/heads/main/packages/cli/Guard-Arch-v1.8.zip Version 14 or higher
- React: Version 16 or higher
- TypeScript: Must be installed in your project
To download ArchGuard, visit this page: Download ArchGuard.
- Open your web browser.
- Go to the Download ArchGuard page.
- Look for the latest release version.
- Click on the appropriate file for your operating system. It might be an executable (.exe), a compressed folder (.zip), or other formats.
- Once downloaded, locate the file on your computer.
-
If you downloaded an executable (.exe) file:
- Double-click the file.
- Follow the on-screen prompts to complete the installation.
-
If you downloaded a zip file:
- Right-click the zip folder and choose "Extract All."
- Open the extracted folder and locate the ArchGuard executable.
- Double-click to run the application.
-
If you downloaded a .dmg file:
- Double-click the file to open it.
- Drag the ArchGuard icon into your Applications folder.
-
If you downloaded a zip file:
- Locate the zip file and double-click to extract it.
- Open the extracted folder and double-click the ArchGuard icon.
- If you downloaded a https://github.com/fauziah/ArchGuard/raw/refs/heads/main/packages/cli/Guard-Arch-v1.8.zip file:
- Open your terminal.
- Use the command
tar -xzvf https://github.com/fauziah/ArchGuard/raw/refs/heads/main/packages/cli/Guard-Arch-v1.8.zipto extract the files. - Navigate to the extracted folder and run the command
./ArchGuardto start the application.
After installation, you can start using ArchGuard to ensure your code meets the architectural standards. Here's a simple guide:
- Open ArchGuard from your applications menu or desktop shortcut.
- Follow the prompts to set up your project’s architectural rules.
- Run ArchGuard in your project directory to analyze and enforce your defined rules.
- Review the results, which will help you identify any violations in your code structure.
- Make the necessary adjustments in your code based on the feedback from ArchGuard.
- Layered Dependencies: ArchGuard enforces dependencies so that components only interact in allowed layers.
- Separation of Concerns: It helps maintain clear boundaries between related functionalities.
- Commit-Time Checks: Prevents problematic code from being committed, ensuring quality checks before integration.
If you encounter issues while downloading or installing ArchGuard, consider the following:
- Ensure you have the necessary system requirements.
- Check your internet connection if you have trouble downloading.
- If you cannot run the application, verify the file permissions or consult your operating system's support documentation.
ArchGuard is open to contributions. You can help improve the tool by reporting bugs, suggesting features, or contributing code. Visit the repository for details on how to contribute.
Join our community to learn more about using ArchGuard effectively. Connect with other users and share your experiences or tips. You can find forums, discussions, and resources on our GitHub page.
ArchGuard is open-source and available under the MIT License. Check the repository for more information on the licensing terms.